PATCH
/
v0
/
webhooks
/
{id}
curl --request PATCH \
  --url https://api.exa.ai/websets/v0/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "events": [
    "webset.created"
  ],
  "url": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "webhook",
  "status": "active",
  "events": [
    "webset.created"
  ],
  "url": "<string>",
  "secret": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Your Exa API key

Path Parameters

​
id
string
required

The id of the webhook

Body

application/json
​
events
enum<string>[]

The events to trigger the webhook

Available options:
webset.created,
webset.deleted,
webset.paused,
webset.idle,
webset.search.created,
webset.search.canceled,
webset.search.completed,
webset.search.updated,
webset.export.created,
webset.export.completed,
webset.item.created,
webset.item.enriched
​
url
string

The URL to send the webhook to

​
metadata
object

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

Response

200
application/json
Webhook
​
id
string
required

The unique identifier for the webhook

​
object
string
default:webhook
required
Allowed value: "webhook"
​
status
enum<string>
required

The status of the webhook

Available options:
active,
inactive
​
events
enum<string>[]
required

The events to trigger the webhook

Available options:
webset.created,
webset.deleted,
webset.paused,
webset.idle,
webset.search.created,
webset.search.canceled,
webset.search.completed,
webset.search.updated,
webset.export.created,
webset.export.completed,
webset.item.created,
webset.item.enriched
​
url
string
required

The URL to send the webhook to

​
secret
string | null
required

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

​
metadata
object | null
required

The metadata of the webhook

​
createdAt
string
required

The date and time the webhook was created

​
updatedAt
string
required

The date and time the webhook was last updated