Skip to main content
POST
0 Credits Set type to batch or monitor to choose which deliveries to list. Use a delivery’s id to retrieve its current status, inspect its attempts, or retry delivery.

Body

application/json
type
enum<string>
required

Delivery source.

Available options:
batch
batch_id
string

Filter by batch ID.

Required string length: 1 - 200
Pattern: ^[\w-]+$
status
enum<string>

Filter by delivery status.

Available options:
pending,
delivering,
retrying,
delivered,
failed,
cancelled
created_after
string<date-time>

Only include events created after this ISO 8601 timestamp.

Example:

"2026-09-01T00:00:00Z"

limit
integer
default:25

Number of deliveries to return.

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

The next_cursor from the previous response.

Pattern: ^whd_[a-f0-9]{32}$
tags
string[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

A page of webhook deliveries

data
object[]
required

Webhook deliveries.

has_more
boolean
required

Whether more deliveries are available.

next_cursor
string | null
required

Next page cursor, or null on the last page.

key_metadata
object

Credit usage, included whenever a valid API key is provided.