ManagementExperimental
List webhook deliveries
Lists the deliveries to one webhook endpoint over the last 7 days, newest first. A delivery is one event: attemptNumber counts the attempts made so far, payload is the body sent, and httpStatus and responseBody are the endpoint's answer to the latest attempt.
/management/webhooks/{webhookEndpointReference}/deliveriesAuthorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
webhookEndpointReferencestringrequiredWebhook endpoint reference, as returned by GET /management/webhooks.
Query parameters
limitintegerMaximum number of items to return (1-100)
20cursorstringOpaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.
Responses
200List of deliveriesapplication/jsonShow response bodyHide response body
dataarray of WebhookDeliveryShow propertiesHide properties
eventTypestringeventIdstringThe webhook-id header every attempt of this delivery carries.
payloadobjectThe request body sent to the endpoint.
responseBodystring | nullBody the endpoint answered on the latest attempt. Null when no attempt reached it.
statusstringpending and sending are in flight, failed will be retried at nextRetryAt, exhausted means every retry failed and no further attempt will be made.
pendingsendingdeliveredfailedexhaustedattemptNumberintegerAttempts made for this delivery so far.
httpStatusinteger | nullStatus code the endpoint answered on the latest attempt. Null when no attempt reached it.
nextRetryAtstring | null · date-timesentAtstring | null · date-timeWhen the latest attempt was sent.
deliveredAtstring | null · date-timeWhen the endpoint acknowledged the event with a 2xx.
paginationobjectShow propertiesHide properties
limitintegerMaximum items per page
hasMorebooleanWhether there are more items after this page
nextCursorstring | nullOpaque cursor token for the next page. Null when there are no more results.
400Bad request - invalid parameters401Unauthorized - missing or invalid API key404Resource not found429Rate limit exceeded. A `429` can also arrive without these headers or this body; handle it by its status code.500Internal server error