Webhook Delivery Overview
A Webhook Delivery represents an individual attempt to send a webhook event to a registered endpoint. It contains details about the HTTP request sent, the response received, and metadata about the event being delivered.
Webhook Delivery Schema
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| entity_id | Identifier of the entity that triggered the webhook event | String |
| entity_type | Type of entity that triggered the webhook (e.g., Payment, Bill, Order) | String |
| webhook_id | Identifier of the webhook configuration used for this delivery | String |
| event | Event type that triggered this webhook delivery (e.g., payment.paid, bill.created) | String |
| created_at | Indicates when the delivery attempt was created in ISO8601 format | String |
| updated_at | Indicates when the delivery record was last updated in ISO8601 format | String |
| response_code | HTTP response code received from the webhook endpoint | Integer |
| request_headers | HTTP headers sent with the webhook request | Object |
| request_body | JSON payload sent in the webhook request body | Object |
| response_headers | HTTP headers received in the webhook response | Object |
| response_body | Response body received from the webhook endpoint | String |
Usage
Webhook Deliveries allow you to:
- Track the delivery status of webhook events
- Debug webhook integration issues by inspecting request and response data
- Verify that your webhook endpoint is receiving and properly handling events
- Identify failed deliveries and understand why they failed
- Monitor webhook performance and reliability
Each webhook delivery record provides complete information about the HTTP transaction, making it easy to troubleshoot integration problems and ensure reliable event notification delivery.