Get a webhook delivery
/v1/webhook-deliveries/{delivery} in the Webhook Deliveries API.
curl https://api.example.test/v1/webhook-deliveries/$DELIVERY_ID \ -H "Authorization: Bearer $TOKEN"One delivery. Another team's delivery is a 404 RESOURCE_NOT_FOUND, never a 403.
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. There is no updated_at: a delivery only moves forward through its statuses, and the three timestamps say when each transition happened.
payloaddiscloses nothing new. The envelope is what your own endpoint already received, or would have had it answered. Reading it needswebhook-delivery:view, and the tenant scope reaches a delivery only through an endpoint of the token's team.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The delivery, resolved by the route binder.
uuidResponses
200OKapplication/json
The delivery with the envelope its endpoint received.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
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 registered a row answers FORBIDDEN with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
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.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on