GET/v1/webhooks/{id}/deliveries

Delivery log of an endpoint

Deliveries newest first with a cursor: the event, the origin (dispatch, replay, test), the attempt count, status, last response code, duration, error, the next attempt and the attempt history with the payload preview.

Scope webhooks.manage

Path parameters

idstringrequired

Query parameters

statusenum
PENDINGSUCCEEDEDFAILEDEXHAUSTED
limitintegermin 1max 200default 50
cursorstringmax length 200

Returns

2 fields of the 200 answer
dataarray of objectsrequired
15 fields
idstringrequired
endpointIdstringrequired
eventIdstringrequired
eventTypeenumrequired
item.createditem.needs_attentionitem.helditem.readyitem.pending_approvalitem.scheduleditem.in_productionitem.handed_to_carrieritem.completeditem.returneditem.not_sentitem.faileditem.cancelleditem.suppressedpostbatch.validatedpostbatch.approvedpostbatch.scheduledpostbatch.completedpostbatch.cancelledimport.completedimport.failedtemplate.publishedpreview.readyqr.scannedand 7 more
originenumrequired
DISPATCHREPLAYTEST
attemptintegerrequired
statusenumrequired
PENDINGSUCCEEDEDFAILEDEXHAUSTED
responseCodeinteger or nullrequired
durationMsinteger or nullrequired
errorstring or nullrequired
nextAttemptAtdate-time or nullrequired
deliveredAtdate-time or nullrequired
attemptsarray of objectsrequired
6 fields
attemptintegerrequired
atdate-timerequired
statusenumrequired
SUCCEEDEDFAILED
responseCodeinteger or nullrequired
durationMsintegerrequired
errorstring or nullrequired
payloadobjectrequired
7 fields
idstringrequired
typeenumrequired
item.createditem.needs_attentionitem.helditem.readyitem.pending_approvalitem.scheduleditem.in_productionitem.handed_to_carrieritem.completeditem.returneditem.not_sentitem.faileditem.cancelleditem.suppressedpostbatch.validatedpostbatch.approvedpostbatch.scheduledpostbatch.completedpostbatch.cancelledimport.completedimport.failedtemplate.publishedpreview.readyqr.scannedand 7 more
versionintegerrequired
createdAtdate-timerequired
organisationIdstringrequired
isTestbooleanrequired
dataobjectrequired
createdAtdate-timerequired
nextCursorstring or nullrequired

Responses

200Success
401Authentication required or API key invalid
403Permission or scope missing, organisation suspended
404Not found
422Validation failed
429Rate limited for this API key and class; wait Retry-After seconds
otherError (RFC 9457 problem details)