EXexa
Webhooks

Get a Webhook

Changed on

Returns a Webhook by id, including its status, subscribed events, target URL, and metadata. The signing secret is not returned.

get/v0/webhooks/{id}

Request

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

Path parameters

idstring required

The id of the webhook

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