Webhooks

List webhook messages

Returns webhook messages sent to the organization, newest first. Scope to an endpoint with endpointId for per-endpoint delivery status and status filtering. Paginate with the iterator cursor returned by the previous page. Message history is retained for 90 days.

get/v1/webhooks/messages

Request

Query parameters

endpointIdstring
Example:ep_1234567890abcdef

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

eventTypesstring[]

Filter by event types (comma-separated)

status'SUCCESS' | 'PENDING' | 'FAIL' | 'SENDING' | 'CANCELED'

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

beforestring
Example:2026-08-01T00:00:00Z

Only include messages created before this timestamp

afterstring
Example:2026-07-01T00:00:00Z

Only include messages created after this timestamp

tagstring
Example:tfr_1234567890abcdef

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

iteratorstring

Pagination cursor returned by a previous page

limitnumber

Number of results to return per page

Headers

X-API-Keystring

API key

Response

Webhook messages retrieved successfully

availableboolean required

Whether delivery history is available. False when webhook delivery is not configured in this environment.

iteratorstring nullable required

Cursor for the next page, when more results exist

doneboolean required

Whether this is the last page

Example response

{
  "data": [
    {
      "id": "msg_1234567890abcdef",
      "eventType": "transfer.completed",
      "tags": [
        "tfr_1234567890abcdef",
        "cus_1234567890abcdef"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 47 revisions of this API.