Skip to main content
GET
List the deliveries of a webhook subscription
  • Credential: an account API key. A trial key returns 401 unauthorized.
  • Line-scoped keys: the list of a line-scoped key is not applied here: the key reads the deliveries of the events of every line of the account.
  • Idempotency-Key: not needed: the operation changes nothing. See Retrying safely.
  • Events: none.
  • Personal data: request_body_snippet contains the beginning of an event, with message text and handles, and response_body_snippet the beginning of the response of your endpoint. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a contact by an id of your own.
  • Guide: Delivery records explains each field, and Retention says how long a record exists. A record describes one delivery and shows its latest attempt.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of the webhook subscription, as returned in id by POST /v1/webhooks: wh_ followed by 25 letters or digits.

Pattern: ^wh_[0-9A-Za-z]{25}$
Example:

"wh_3Kp8Rn9Fh2Lm5Qx7Vw1Yz4Bc6"

Query Parameters

limit
integer
default:20

Number of deliveries per page, from 1 to 100. Default: 20.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Omit it for the first page. Send the same filters on every page.

status
enum<string>

Keep the deliveries in this status: pending, success or failed.

Available options:
pending,
success,
failed
event
string

Keep the deliveries of this exact event type, for example message.received. Wildcards are not interpreted. At most 100 characters.

Maximum string length: 100
Example:

"message.received"

since
string<date-time>

Keep the deliveries created at or after this timestamp: ISO 8601 in UTC ending in Z. A UTC offset such as +02:00 returns 400 validation_failed.

Example:

"2026-10-08T12:00:00Z"

until
string<date-time>

Keep the deliveries created at or before this timestamp: ISO 8601 in UTC ending in Z. A UTC offset such as +02:00 returns 400 validation_failed.

Example:

"2026-10-08T18:00:00Z"

Response

One page of deliveries.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

One page of deliveries.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.