Skip to navigation

Retrieve a delivery

View as Markdown

Returns one delivery with all of its attempts, the event envelope sent to the endpoint (event, rebuilt from the stored event: same fields and values, although key order may differ from the signed bytes), and the request headers of the last attempt. request_headers lists only webhook-id, webhook-timestamp and the x-jelliu-* headers; the signature and custom headers are never returned.

Error codes in last_error and attempts[].error are stable, machine-readable codes: timeout, url_not_allowed, connection_error (optionally connection_error:<errno>, for example connection_error:ECONNREFUSED), http_<status>, signing_secret_unreadable, custom_headers_unreadable, custom_headers_invalid, attempt_abandoned, and for canceled deliveries endpoint_deleted, endpoint_disabled, event_missing or subscription_inactive.

Idempotency. A read with no side effects. Safe to retry.

Access

  • Required scope: read or write. Any workspace role can call it.
  • Rate limit: General API — 120 requests/min per workspace on Starter or with no active plan, 200 on Growth, 300 on Business, 600 on Enterprise. See Rate limits.
  • Plan: Available on every plan and also without an active subscription. See Billing and usage.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

deliveryIdstringRequiredformat: "^dlv_[0-9A-HJKMNP-TV-Z]{26}$"

Id of a webhook delivery (dlv_ plus 26 characters), as returned in id by GET /api/webhooks/{webhookId}/deliveries and sent in the x-jelliu-delivery-id header. A delivery of another workspace, an unknown id or a value that is not a delivery id answers 404.

Response

The delivery.
dataobject
A delivery with its attempts, the event envelope and the request headers.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error