Open Connector
Delivery API

Delivery API

Inspect receiver admission and retry outcomes, then replay retained events under the active grant.

Inspect receiver admission and retry outcomes, then replay retained events under the active grant.

Use the shared request contract for authentication, pagination, preconditions, idempotency, and common errors. Exact response members are defined in API data types and the downloadable OpenAPI contract.

List deliveries

GET/api/v1/connector/organizations/{organization_id}/subscriptions/{subscription_id}/deliveries
Scope
deliveries:read
Auth
Bearer API key

Lists delivery states, stable event IDs, and attempt outcomes.

Query parameters
limitintegeroptional

Number of records; bounds are inclusive.

default50rule1–200
cursorstringoptional

Opaque continuation; preserve the original filters.

event_idstringoptional

Filter one stable event identity.

statestringoptional

Filter one state.

one ofqueued, retrying, delivered, failed, suppressed
200Result

Returns a data array of Delivery records, pagination.next_cursor, and request_id.

Read a delivery

GET/api/v1/connector/organizations/{organization_id}/subscriptions/{subscription_id}/deliveries/{delivery_id}
Scope
deliveries:read
Auth
Bearer API key

Returns attempts and the last HTTP or transport result.

delivered means the receiver acknowledged receipt. It does not mean a ticket, deployment, or native response completed.

200Result

Returns data as Delivery, plus request_id.

Replay a delivery

POST/api/v1/connector/organizations/{organization_id}/subscriptions/{subscription_id}/deliveries/{delivery_id}/replay
Scope
deliveries:write
Auth
Bearer API key
Repeat calls
Organization-scoped Idempotency-Key; 24 hours

Starts a delivery window for the same event under present authorization.

Requires Idempotency-Key.

Requires an enabled subscription and active connection. A paused or revoked path returns 409 connection_inactive; an expired event returns 410 event_expired. Replays use a fresh timestamp and active signing version. Unchanged event identity requires receiver deduplication. Replay is not a way to restore removed grants.

Request body
reasonstringrequired

Audited reason; empty values are rejected.

rule1–2000 characters
202Accepted

Returns operation.id for operation polling and request_id; acceptance does not establish completion.