Objects
WebhookDelivery
Fields
expandedWebhookDeliveryExpandedidintegerrequiredwebhook_idintegerrequiredevent_idstringrequiredEvent ID (
evt_…), also sent in theX-KB-Event-Idheader and in the delivery body.event_created_atstring (date-time)requiredattemptintegerrequiredNumber of attempts made.
response_codeinteger | nullduration_msinteger | nullnext_retry_atstring (date-time) | nullerrorstring | nulldelivered_atstring (date-time) | nullcreated_atstring (date-time)requiredupdated_atstring (date-time)requiredsequenceinteger | nullNumber in the delivery order of the webhook (
X-KB-Sequence);nullfor a test delivery.testbooleanrequiredA test delivery (
POST /v1/webhooks/{webhook_id}/test).redelivery_ofinteger | nullThe original delivery, if this one is a redelivery.
error_codestring | nullNeutral code of the last failure:
timeout,connection_failed,tls_error,private_address,unresolvable,redirect,http_error,request_failed,endpoint_disabled,event_expired; a cancelled delivery (cancelled) can also haveevent_not_permitted(the event is outside the rights of the webhook at the time of the attempt, because the rights were narrowed after fan-out) orevent_unavailable(the body of a test delivery is no longer available).
Used by
- POST
/v1/webhooks/{webhook_id}/testSend a test event - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverRedeliver an event