Get delivery
Returns one delivery with its status, attempts and last error. request_body is the exact JSON that was signed and sent, and response_body_truncated the first 1 KiB of the answer of your server; both are null unless your key has the read scope of the event family, and request_body is also null 7 days after the outcome. Use it to see why an event failed before you resend it. Required scope: webhooks:manage. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.
Authentication
Path parameters
Id of the delivery, as returned by GET /webhook-endpoints/{endpoint_id}/deliveries.
Headers
API version for this request; defaults to the version the key is pinned to.
Response
Always webhook_delivery.
Id of the delivery: use it in GET /webhook-deliveries/{delivery_id}.
Id of the event. It is the same on every attempt and on a resend, and it is the VoxAI-Event-Id header: use it to ignore an event you already processed.
The type of the event, for example call.ended; webhook.test for a test event.
pending: waiting for the next attempt. delivered: your server answered with a 2xx status. failed: every attempt failed and no more will be made. discarded: the feature was switched off before it was sent.
When the next attempt is due, ISO 8601 UTC. null unless status is pending, and always null for a test or a resend.
HTTP status of the last answer of your server; null if it did not answer.
A short safe code for the last failure, null if the last attempt succeeded: http_<status> (for example http_503), timeout, network, dns, address_not_allowed, port_not_allowed, internal_error, feature_not_available, expired, attempt_lost, error. Never text from your server.
How long the last attempt took, in milliseconds; null if there was none.
A test event or a resend: it counts neither as a failure nor towards the automatic disabling (a success resets the counter).
Id of the delivery this one is a resend of; null if it is not a resend.
true if the body carries the transcript of the call.
When the delivery reached its outcome, ISO 8601 UTC; null while it is pending.
true with a test key: the request was validated and NOT sent.
The exact JSON text that was signed and sent, while it is still kept (7 days after the outcome). null after that, and for a key without the read scope of the event family.
At most the first 1 KiB of your server’s answer, if it sent any. null for a key without the read scope of the event family.