Retrieve a list of failed webhook events

Get the list of all your failed webhook events, or use the query parameters to filter the results.

The events are sorted by the created_at date in reverse chronological order.

The returned failed events are paginated. The maximum number of events returned per page is specified by the limit parameter. To get to the next page, make a new request and use the created_at date of the last event returned in the previous response.

For more information, see the guides: About webhooks and Manage webhooks.

Request

Path Parameters
Path Parameters

The ID of the webhook for which to get the failed events.

Query Parameters
Query Parameters

Possible values: >= 1 and <= 1000

Default value: 100

The maximum number of events returned per page.

To get to the next page, make a new request and use the created_at date of the last event returned in the previous response as value for created_before.

Possible values: >= 'created_at' - 21 days

Default value: the date-time at which the request is made

Retrieves events with created_at < created_before. Cannot be older than the current date minus 21 days. The default value is the current date and time at which you are calling the endpoint.

Provided in ISO 8601 format.

Response

The list of all your existing failed webhook events

Response body
Body array of objects

The ID of the webhook event.

The date and time the event was created in ISO 8601 format.

The date and time the event was last updated in ISO 8601 format.

The ID of the webhook for which the event failed.

The valid webhook URL that event notifications are sent to. The supported protocol is https.

The details of the failed event.

The date and time the last attempt at the event delivery occurred in ISO 8601 format.

Was this page helpful?