Retrieve a webhook deliveryMenu

Retrieve a webhook delivery

GET/v1/webhooks/deliveries/{id}

Requires an API key with the webhooks:read scope. About keys and scopes

Works with integration, agent and partner keys.

Returns one delivery: the one a test or a redelivery queued, to watch it move from pending to delivered or failed.

Path parameters

idstringrequired

The delivery's id.

uuid

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

Returns 200 OK with a WebhookDelivery in data. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

webhookIdstringrequired

The webhook (endpoint) it was sent to.

uuid

eventIdstringrequired

The event; the same across retries.

uuid

eventTypestringrequired

The event type, such as message.delivered.

one of contact.created, contact.unsubscribed, contact.consent_changed, form.submitted, campaign.sent, journey.enrolled, message.delivered, message.bounced, message.complained, message.opened, message.clicked, message.failed, message.skipped, message.sent, journey.action_reached, webhook.test

attemptintegerrequired

Which attempt this was, starting at 1.

statusstringrequired

one of pending, delivered, failed

nextAttemptAtstring | nullrequired

When a pending delivery is tried next. Null once delivered or failed, and while its webhook is paused or disabled: it then waits until the webhook is active.

date-time

responseStatusinteger | nullrequired

The HTTP status your endpoint returned; null if it did not respond.

failureReasonstring | nullrequired

Why the attempt failed: HTTP 500 for an error reply; with no reply, the network error, such as fetch failed: ECONNREFUSED, fetch failed: ENOTFOUND, fetch failed: CERT_HAS_EXPIRED or No reply within 5 seconds.

requestBodystring | nullrequired

The exact body sent, while the delivery is pending or failed; null once delivered, when it is dropped.

responseBodystring | nullrequired

The first 1 KB of the endpoint's last reply.

createdAtstringrequired

date-time

deliveredAtstring | nullrequired

When your endpoint accepted it.

date-time