Skip to content
cascadehook.docs
API referenceDeliveries

List deliveries

Returns newest-first retained data. Unknown or repeated query parameters are rejected. Follow next_cursor until null; preserve filters. Omit cursor on the first page. To confirm a test, filter by BOTH the accepted event ID and the chosen endpoint ID. Poll at intervals of at least five seconds for at most 60 seconds; honor Retry-After.

GET
/v1/deliveries

Returns newest-first retained data. Unknown or repeated query parameters are rejected. Follow next_cursor until null; preserve filters. Omit cursor on the first page. To confirm a test, filter by BOTH the accepted event ID and the chosen endpoint ID. Poll at intervals of at least five seconds for at most 60 seconds; honor Retry-After.

Authorization

projectAPIKey
headerAuthorizationBearer <ch_dev_ or ch_live_ project API key>

Read CASCADEHOOK_API_KEY from the local environment. Never print keys or headers. Scope is the project selected when the key was created.

Query Parameters

limit?integer
Range1 <= value <= 100
Default20
cursor?string

Opaque next_cursor from the preceding page; omit on the first page. Keep filters unchanged.

Length1 <= length <= 512
event_id?string
Formatuuid
endpoint_id?string
Formatuuid
state?string
Value in"pending""leased""succeeded""failed""canceled"

Response Body

List deliveries

application/json
  1. response
data*array<>
next_cursor*|

Opaque cursor. Null means the final page. Repeat the same filters when continuing.

Example Request
curl -X GET 'https://api.cascadehook.com/v1/deliveries'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",      "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",      "state": "pending",      "attempt_count": 0,      "cycle": 0,      "cycle_started_at": "2019-08-24T14:15:22Z",      "retry_deadline": "2019-08-24T14:15:22Z",      "next_attempt_at": "2019-08-24T14:15:22Z",      "terminal_reason": "string",      "active_attempt_id": "b78ef144-8036-4e06-8451-5c86b5e7eb8e",      "active_attempt_started_at": "2019-08-24T14:15:22Z",      "lease_expires_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}

Read current delivery state GET

succeeded confirms receiver acknowledgement, not downstream business completion. pending/leased are not terminal. Inspect attempts and terminal_reason for failures.

List completed delivery attempts GET

Newest logical attempt first; cursor is bound to its delivery and cycle filter. Response bodies and sensitive headers are never exposed. Unknown or repeated query parameters are rejected.