Skip to main content
POST
0 credits See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

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[]

Labels for filtering usage in the dashboard.

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.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credits this request used and your remaining balance.