Developers
Webhooks

List deliveries for a webhook endpoint

GET/webhooks/{webhook_id}/deliveries

Returns the deliveries of a webhook endpoint, paginated by cursor. The collection can be filtered by status, event ID, 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

Path Parameters

webhook_id*string

Query Parameters

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

Value in

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

Value in

  • "pending"
  • "in_progress"
  • "delivered"
  • "failed"
  • "dead"
  • "canceled"
event_id?string
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

application/json

curl -X GET "https://example.com/webhooks/string/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"  }}

Delete a webhook endpoint DELETE

Deletes a webhook endpoint so that it no longer receives events. Deliveries that are still pending are canceled. Deliveries that have already completed are not affected.

Retrieve a webhook delivery GET

Retrieves a webhook delivery, including `attempts_count`, `next_attempt_at`, and its most recent attempt.