Sign in
Webhooks

Retrieve a single webhook

get/webhooks/{webhook_id}

Path parameters

webhook_idstring uuid required

The Webhook ID.

Response

OK

objectstring

The type of object.

idstring uuid

The ID of the webhook.

endpointstring

The URL where webhook events are sent.

eventsstring[] nullable

Array of event types subscribed to.

statusstring

The status of the webhook.

created_atstring

Timestamp indicating when the webhook was created.

signing_secretstring

The secret key used to verify webhook payloads.

Example response

{
  "object": "webhook",
  "id": "479e3145-dd38-476b-932c-529ceb705947",
  "endpoint": "https://webhook.example.com/handler",
  "events": [
    "email.sent",
    "email.delivered"
  ],
  "status": "enabled",
  "created_at": "2023-10-06 23:47:56.678+00",
  "signing_secret": "whsec_..."
}

Changes