Management APIWebhooks

List webhook events

Returns a list of all webhook events matching the query parameters provided. Expired events are not included.

Scopes: WEBHOOK_EVENTS_READ

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

webhook_endpoint_idstringOptional>=1 character<=128 characters
Events delivered to this webhook endpoint ID.
statusenumOptional
The status of an event that was delivered to a webhook endpoint. The status can either be PENDING, SUCCESS, or FAILED.
Allowed values:
event_typeenumOptional
The type of event that will be sent to the webhook endpoint.
cursorstringOptional
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.
limitintegerOptional>=1<=500Defaults to 100
Maximum number of webhook events to return.

Response

OK
webhook_eventslist of objects
cursorstring or null
The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors