List Webhook Events

GET /webhooks/:webhookId/events

Lists all events for a given webhook.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

We only keep a trace of those Webhook Events in our system for a retention period of 31 days. Past that, they are discarded, so you cannot see them using List Webhook Events or Get Webhook Event endpoints.

Permissions Required

• Webhooks:Events:Read

Request Params

The following query parameters can be appended to the url

Property	Type	Description
deliveryFailed	Boolean - Optional	If this query parameter is not specified, all Webhook Events will be returned (whether their delivery failed or not). If you pass deliveryFailed=true , only the webhook events which delivery failed are returned. If you pass deliveryFailed=false only the events which delivery succeeded are returned. (more details here)
limit	Number - Optional	Maximum number of items included in response
paginationToken	String - Optional	Page cursor used (taken from the previous response nextPageToken).

Response

See Webhook Event Data for more details on potential response formats by webhook event kind.

{
  "items": [
    {
      "id": "wh-xxx-xxxxxxx",
      "kind": "wallet.transfer.confirmed",
      "date": "2023-12-04T10:02:22.280Z",     
      "deliveryFailed": false,
      "deliveryAttempt": 1,
      "timestampSent": 1701684144,
      "status": "200",
      "data": {
        ... // content depending on the kind of events it is
      },
    },
    ...
  ],
  "nextPageToken": "eJxNy8...."
}

Property	Type	Description
items	List of Objects	List of Webhook Event objects as detailed in the Get Webhook Event endpoint.
nextPageToken	String - Optional	Page cursor used (taken from the previous response nextPageToken). Will not be set if this is last page.