--- title: "Get a webhook delivery" method: GET path: "/v1/webhook-deliveries/{delivery}" tags: ["Webhook Deliveries"] --- # Get a webhook delivery `GET /v1/webhook-deliveries/{delivery}` ## Request - Base URL: `https://api.subscriby.net` - URL: `https://api.subscriby.net/v1/webhook-deliveries/{delivery}` - Auth: HTTP bearer ```bash curl https://api.subscriby.net/v1/webhook-deliveries/$DELIVERY_ID \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN" ``` One delivery. Another team's delivery is a `404 RESOURCE_NOT_FOUND`, never a `403`. | Field | Type | Notes | | ------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `event` | string | The event name, as in the [catalog](https://docs.subscriby.net/api/v1/reference/webhook-events). | | `event_id` | string | The 26-character ULID the envelope's `id` carries without its `evt_` prefix; also the `SB-Event-Id` header your handler received. | | `status` | string | `pending`, `delivered`, `failed` or `dead`. See below. | | `attempts` | integer | Posts made so far. Reset to `0` by a retry. | | `response_status` | integer or null | The HTTP status your endpoint returned on the last attempt; `null` before the first post or after a transport failure. | | `response_excerpt` | string or null | The start of the response body, or the transport error. | | `payload` | object | The full [event envelope](https://docs.subscriby.net/webhooks/v1/events) that was, or would have been, posted, so a consumer can be debugged against it exactly. | | `next_attempt_at` | string or null | When the worker will post a `failed` row again. | | `delivered_at` | string or null | Stamped on the first 2xx. | | `dead_lettered_at` | string or null | Stamped when the ladder ran out. | There is no `updated_at`: a delivery only moves forward through its statuses, and the three timestamps say when each transition happened. A row is born `pending`, becomes `failed` after a non-2xx or transport error while retries remain, `delivered` on the first 2xx, and `dead` once the ladder is exhausted or the endpoint vanished. `delivered` and `dead` are final until a retry resets the row to `pending`. > **`payload` discloses nothing new.** The envelope is what your own endpoint already received, or would have had it answered. Reading it needs `webhook-delivery:view-any`, and the tenant scope reaches a delivery only through an endpoint of the token's team. ## Path parameters - `delivery` string, uuid, required ## Response `200` The delivery with the envelope its endpoint received. - object - `data` WebhookDeliveryResource, required: One row of the webhook delivery log: one endpoint, one event, the signed envelope that was posted, what the target answered and where the row is on the retry ladder. - `id` string, required: The delivery's id, the value the retry endpoint takes. - `endpoint_id` string, required: The webhook endpoint the event was posted to. - `event` string, required: The event name, as the catalog lists it. - `event_id` string, required: The 26-character ULID the envelope's `id` carries without its `evt_` prefix; also the `SB-Event-Id` header the handler received. - `status` string, required: `pending` (born, or reset by a retry), `failed` (a non-2xx or transport error while retries remain), `delivered` (the first 2xx) or `dead` (the ladder ran out or the endpoint vanished). `delivered` and `dead` are final until a retry. - `attempts` integer, required: Posts made so far. Reset to 0 by a retry. - `response_status` integer, nullable, required: The HTTP status the endpoint returned on the last attempt; null before the first post or after a transport failure. - `response_excerpt` string, nullable, required: The start of the response body, or the transport error; null before the first post. - `payload` unknown[], required: The full event envelope that was, or would have been, posted, so a consumer can be debugged against it exactly. - unknown - `next_attempt_at` string, nullable, required: When the worker will post a `failed` row again, ISO 8601; null otherwise. - `delivered_at` string, nullable, required: Stamped on the first 2xx, ISO 8601; null until then. - `dead_lettered_at` string, nullable, required: Stamped when the ladder ran out, ISO 8601; null otherwise. - `created_at` string, required: When the row was born, ISO 8601. ## Other responses - `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production). - `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description. - `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. - `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted. --- [API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/7b538e472e9a?raw)