GET /v1/webhooks/{webhookId}/deliveries
List a receiver's recent deliveries
The receiver's newest deliveries, order events and test events, newest first: state (pending, failed, delivered, dead), attempts, the last HTTP status and error. Use it to see why your receiver is not getting events. Free.
| Key | Required. See Authentication. |
|---|---|
| Scope | webhooks.read |
| Price | free. How pricing works. |
Example
curl -s "https://api.compudime.com/v1/webhooks/{webhookId}/deliveries" \
-H "Authorization: Bearer $PUBLIC_API_KEY"Parameters
| Name | In | Type | Description |
|---|---|---|---|
webhookId required | path | string | The receiver's id (id in the answer of POST /v1/webhooks or GET /v1/webhooks). An id your key has no receiver under is 404 webhook_not_found. |
limit | query | integer | How many deliveries to return, newest first: 1 to 100; omitted, 20. Anything else is 400 bad_request. At least 1. At most 100. |
Responses
| Status | Description | Body |
|---|---|---|
200 | The receiver's newest deliveries. | WebhookDeliveryListResponse |
400 | limit is not a whole number from 1 to 100 (code bad_request). | Problem |
401 | Public API key is missing, invalid, or revoked. | Problem |
403 | The API key is not enabled for this endpoint. | Problem |
404 | Your key has no receiver with this id: it never existed, belongs to another integration or to a key of the other mode, or you removed it (code webhook_not_found). | Problem |
405 | The requested method is not allowed for this endpoint. | Problem |
429 | Too many requests from this API key (code rate_limited). Each key has its own request budget at the API edge, refilled continuously; it covers every authenticated endpoint, including the free ones, and is checked before anything is billed or sent to the store. Wait at least Retry-After seconds before the next request with this key, then resume; if 429 answers again, back off exponentially (double the wait each time, up to a minute or so) and add random jitter so parallel workers do not retry in step. A 429 is never charged and reserves nothing. Header Retry-After: Whole seconds to wait before retrying with this key: the time until the key's next request token at the edge (never less than 1), or 60 when the store plan's per-minute ceiling refused the call. | Problem |
500 | The API edge encountered an internal error. | Problem |
503 | A required Public API dependency is temporarily unavailable. Also answered, with code endpoint_disabled, while CompuDime has temporarily switched the endpoint off: the whole API, the endpoint's family (x-compudime-family) or this endpoint alone; the detail says which and why. It is checked before anything is validated, reserved or sent to the store, so it is never charged; it is retryable and carries Retry-After. Header Retry-After: Sent with code endpoint_disabled: whole seconds to wait before asking again. A switch has no scheduled end, so this is a polling interval (60), not a promise. | Problem |
Error bodies are problem JSON; every code is listed there.
Access level
What your integration's access level changes here.
| Level | Scope | Effect |
|---|---|---|
own | webhooks.read | The level does not change this operation: own and all return the same data. |
all | webhooks.read | The level does not change this operation: own and all return the same data. |