Developers
Webhooks

List all webhook deliveries

GET/webhooks/deliveries

Returns webhook deliveries across all webhook endpoints accessible with the current credentials, paginated by cursor. The collection can be filtered by webhook endpoint, status, event type, and creation time.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

  • "created_at"
  • "-created_at"
webhook_id?string
status?string

Value in

  • "pending"
  • "in_progress"
  • "delivered"
  • "failed"
  • "dead"
  • "canceled"
event_type?string
created_after?string
Formatdate-time
created_before?string
Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhooks/deliveries"
{  "data": [    {      "attempts_count": 0,      "created_at": "2019-08-24T14:15:22Z",      "deadline_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "id": "string",      "last_attempt": {        "duration_ms": 0,        "finished_at": "2019-08-24T14:15:22Z",        "http_status": 0,        "next_attempt_at": "2019-08-24T14:15:22Z",        "number": 0,        "object": "webhook_delivery_attempt",        "origin": "automatic",        "response_excerpt": "string",        "started_at": "2019-08-24T14:15:22Z",        "transport_error": "string"      },      "next_attempt_at": "2019-08-24T14:15:22Z",      "object": "webhook_delivery",      "status": "pending",      "url": "string",      "webhook_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Create a webhook endpoint POST

Creates a webhook endpoint that receives events for the subscribed event types. The destination URL must use HTTPS and point to a public host on port 443, 80, or 8443. Private IP addresses and other non-public destinations are rejected before the endpoint is created. `http://localhost` is accepted only in sandbox accounts. The response includes the signing secret. It is returned only once and cannot be retrieved again.

Retrieve a webhook endpoint GET

Retrieves a webhook endpoint, including its current `revision` and a `health` summary for the last 24 hours. The signing secret is never included. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the endpoint to avoid overwriting a newer version.