List webhook deliveries
List delivery attempts (and their status) for a webhook endpoint. Each event delivery is recorded in `api.webhook_deliveries`.
List delivery attempts (and their status) for a webhook endpoint. Each event delivery is recorded in api.webhook_deliveries.
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
UUIDv7 identifier of the resource.
uuidQuery Parameters
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
Page size. Values above the maximum are clamped.
1 <= value <= 10025Filter by delivery status.
Value in
- "pending"
- "delivering"
- "succeeded"
- "failed"
- "retrying"
- "exhausted"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "webhook_delivery", "webhook_endpoint_id": "3d87177d-a059-4900-ae4a-408283ca1e94", "event_type": "string", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "status": "pending", "attempts": 0, "max_attempts": 0, "response_status": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "delivered_at": "2019-08-24T14:15:22Z", "last_error": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}