Section ID:
Values of
DOC-API-MODEL-schema-1fiv947q56#overview
EventDelivery
Delivery-attempt state and response information for a webhook event.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1fiv947q56#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1fiv947q56#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1fiv947q56#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-idSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-idid | string | Optional | Identifier of the event delivery record. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-eventidSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-eventideventId | string | Optional | Identifier of the webhook event being delivered. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-endpointidSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-endpointidendpointId | string | Optional | Identifier of the webhook endpoint receiving deliveries. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-statusSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-statusstatus | string (DELIVERY_STATUS_SCHEDULED, DELIVERY_STATUS_PROCESSING, DELIVERY_STATUS_COMPLETED, DELIVERY_STATUS_RETRY, DELIVERY_STATUS_FAILED, DELIVERY_STATUS_DISCARDED) or integer (int32) | Optional; explicit presence | Current delivery status reported for this webhook event attempt. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-attemptsSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-attemptsattempts | string (int64) | Optional | Number of delivery attempts reported for the webhook event. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-eventtypeSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-eventtypeeventType | string | Optional | Type of the webhook event represented by this delivery. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-createdatSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-updatedatSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-httpstatusSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-httpstatushttpStatus | string (int64) | Optional | HTTP response status reported for the delivery attempt. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-responsedataSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-responsedataresponseData | string | Optional | Response body reported by the webhook delivery target. |
Section ID: DOC-API-MODEL-schema-1fiv947q56#field-errorSection ID: DOC-API-MODEL-schema-1fiv947q56#response-field-errorerror | string | Optional | Error information reported for this operation or item. |
Values of status
Section ID: DOC-API-MODEL-schema-1fiv947q56#response-values-status
Current delivery state of a webhook event sent to an endpoint.
| Value | No. | Form | Meaning |
|---|---|---|---|
DELIVERY_STATUS_SCHEDULED | 0 | Canonical | The delivery is scheduled and waiting for processing. |
DELIVERY_STATUS_PROCESSING | 1 | Canonical | The delivery backend is processing a delivery attempt. |
DELIVERY_STATUS_COMPLETED | 2 | Canonical | See meaning below. |
DELIVERY_STATUS_RETRY | 3 | Canonical | The delivery is awaiting another attempt after a retryable failure. |
DELIVERY_STATUS_FAILED | 4 | Canonical | The delivery is reported as failed by the backend. |
DELIVERY_STATUS_DISCARDED | 5 | Canonical | The delivery backend discarded the event instead of completing delivery. |
DELIVERY_STATUS_COMPLETED
The webhook delivery completed successfully.
Terminal.
Where used
Section ID: DOC-API-MODEL-schema-1fiv947q56#where-used
| Reference | Relationship |
|---|---|
| List webhook event deliveries | POST /api/v1/webhooks/list-deliveries |
| Retry a failed webhook delivery | POST /api/v1/webhooks/retry-delivery |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1fiv947q56