List a Webhook subscription's deliveries
GET /v1/webhooks/{webhook_id}/deliveries
| Property | Value |
|---|---|
| Operation | list_webhook_deliveries |
| Group | Webhooks |
| Scope | webhooks:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A metadata read; a subscription and its deliveries hold URLs, ids, codes and measurements, never Call content. |
| Released in | 1.63.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Lists the deliveries of the subscription, newest first, optionally by status or event, from the 30-day log (a target; 1.63.0, FR-webhooks-2): what made each, its status, attempts and next attempt, and the last answer's status code, error code and duration. Never a payload.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/webhooks/whk_.../deliveries" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/webhooks/whk_.../deliveries`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/webhooks/whk_.../deliveries",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
webhook_id | path | WebhookId | yes | The id of a Webhook subscription: whk_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
status | query | WebhookDeliveryStatus | no | Only the deliveries in this status. |
event_id | query | EventId | no | Only the deliveries of this event. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | WebhookDeliveryList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is WebhookDeliveryList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of WebhookDelivery | yes | The deliveries of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |