API reference
List an endpoint's deliveries
GET
Newest first. Each delivery carries its attempts: when each was sent, the status your server answered with and how long it took. Deliveries are kept as long as their event, 30 days.
Required scope: webhooks:read (webhooks:write also works).
Errors
- 400:
invalid_cursor,unknown_event_type,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
webhook_endpoint_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe webhook endpoint's ID.
Length
1 <= length <= 200limit?integerPage size, 1 to 100. Defaults to 25.
Range
1 <= value <= 100Default
25cursor?stringThe nextCursor from the previous page.
Length
1 <= length <= 2048status?stringOnly deliveries in this status.
Value in
"pending""running""succeeded""failed""cancelled"eventType?stringOnly deliveries of this event type, for example report.completed.
Length
1 <= length <= 100Success.
application/json- response
object*stringdata*array<>The deliveries on this page.
hasMore*booleanWhether another page follows.
nextCursor*|Pass as cursor to fetch the next page, or null at the end.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/webhook-endpoints/ID_VALUE/deliveries" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "list", "data": [ { "object": "webhook_delivery", "id": "string", "endpointId": "string", "eventId": "string", "eventType": "string", "actor": { "type": "api_key", "id": "string" }, "status": "pending", "attemptCount": -9007199254740991, "nextAttemptAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "attempts": [ { "number": -9007199254740991, "startedAt": "2019-08-24T14:15:22Z", "httpStatus": -9007199254740991, "outcome": "string", "durationMs": -9007199254740991 } ] } ], "hasMore": true, "nextCursor": "string"}