EXexa
Webhooks

Create a Webhook

Changed on

Creates a Webhook that delivers the selected events to your URL as they occur.

The response includes the signing secret used to verify deliveries; it is only returned on creation.

post/v0/webhooks

Request

  • Base URL
    https://api.exa.ai/websets
  • URL
    https://api.exa.ai/websets/v0/webhooks
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

eventsEventType[] required

The events to trigger the webhook

urlstring uri required

The URL to send the webhook to

metadataobject

Set of key-value pairs you want to associate with this object.

Response

Webhook

idstring required

The unique identifier for the webhook

object'webhook' required

The type of object

status'active' | 'inactive' required

The status of the webhook

eventsEventType[] required

The events to trigger the webhook

urlstring uri required

The URL to send the webhook to

secretstring nullable required

The secret to verify the webhook signature. Only returned on Webhook creation.

metadataobject

The metadata of the webhook

createdAtstring date-time required

The date and time the webhook was created

updatedAtstring date-time required

The date and time the webhook was last updated

Changes

  • a56858d08d37Revision changes
    • warning

      the / request property's maxLength was set to 250

  • a345d0f03b0dRevision changes
    • breaking

      added 'propertyNames' constraint to the request property

    • info

      added 'propertyNames' constraint to the response property for the status