EventDelivery
Delivery-attempt state and response information for a webhook event.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
id | string | Optional | Identifier of the event delivery record. |
eventId | string | Optional | Identifier of the webhook event being delivered. |
endpointId | string | Optional | Identifier of the webhook endpoint receiving deliveries. |
status | string (DELIVERY_STATUS_SCHEDULED, DELIVERY_STATUS_PROCESSING, DELIVERY_STATUS_COMPLETED, DELIVERY_STATUS_RETRY, DELIVERY_STATUS_FAILED, DELIVERY_STATUS_DISCARDED) or integer (int32) | Optional | Current delivery status reported for this webhook event attempt. |
attempts | integer (int32) | Optional | Number of delivery attempts reported for the webhook event. Minimum: -2147483648. Maximum: 2147483647. |
eventType | string | Optional | Type of the webhook event represented by this delivery. |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
httpStatus | integer (int32) | Optional | HTTP response status reported for the delivery attempt. Minimum: -2147483648. Maximum: 2147483647. |
responseData | string | Optional | Response body reported by the webhook delivery target. |
error | string | Optional | Error information reported for this operation or item. |
Values of status
Delivery-backend state of a webhook event sent to an endpoint.
| Value | No. | Form | Meaning |
|---|---|---|---|
DELIVERY_STATUS_SCHEDULED | 1 | Canonical | The delivery is scheduled and waiting for processing. |
DELIVERY_STATUS_PROCESSING | 2 | Canonical | The delivery backend is processing a delivery attempt. |
DELIVERY_STATUS_COMPLETED | 3 | Canonical | The webhook delivery completed successfully. |
DELIVERY_STATUS_RETRY | 4 | Canonical | The delivery is awaiting another attempt after a retryable failure. |
DELIVERY_STATUS_FAILED | 5 | Canonical | The delivery is reported as failed by the backend. |
DELIVERY_STATUS_DISCARDED | 6 | Canonical | The delivery backend discarded the event instead of completing delivery. |
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: DOC-API-MODEL-event-delivery.