Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Query Parameters

endpointId
string

Scope results to a single endpoint. Required for status filtering.

Example:

"ep_1234567890abcdef"

eventTypes
string[]

Filter by event types (comma-separated)

Example:

"transfer.completed,transfer.failed"

status
enum<string>

Filter by delivery status. Only applies when endpointId is provided.

Available options:
SUCCESS,
PENDING,
FAIL,
SENDING,
CANCELED
before
string

Only include messages created before this timestamp

Example:

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

after
string

Only include messages created after this timestamp

Example:

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

tag
string

Filter by resource tag, e.g. a transfer or customer ID carried on the message

Example:

"tfr_1234567890abcdef"

iterator
string

Pagination cursor returned by a previous page

limit
number
default:50

Number of results to return per page

Required range: 1 <= x <= 250

Response

Webhook messages retrieved successfully

available
boolean
required

Whether delivery history is available for this organization. False when the organization uses a custom delivery integration.

data
object[]
required
iterator
string | null
required

Cursor for the next page, when more results exist

done
boolean
required

Whether this is the last page