The webhook delivery object

Represents a webhook delivery generated for your provider, including its delivery status and delivery attempts.

A webhook delivery is a webhook payload that Check generated for your provider. Each delivery includes the topic that was sent to your webhook endpoint, a derived delivery status, and the delivery attempts made for that delivery.

{
  "id": "whe_7uCODm8JFmZyov9jL8QO",
  "webhook_config": "whc_7uCODm8JFmZyov9jL8QO",
  "company": "com_zH8Gq33iBkFj5o0GKjTw",
  "topic": "payroll",
  "status": "delivered",
  "created_at": "2024-01-19T17:04:15Z",
  "attempts": [
    {
      "status_code": 200,
      "created_at": "2024-01-19T17:04:15Z"
    }
  ]
}
AttributeDescription
id
string
Unique identifier for the webhook delivery.
webhook_config
string
Webhook config that received this delivery, or null if the delivery has no associated config.
company
string
Company associated with the delivery, when applicable.
topic
string
Webhook topic for the delivery.
status
string
Delivery status of the webhook delivery. One of pending, retrying, delivered, or failed.
created_at
string
Timestamp when the webhook delivery was created.
attempts
array
Delivery attempts for the webhook delivery, ordered newest first. Each attempt includes status_code and created_at.
attempts[].status_code
integer
HTTP status code returned by your webhook endpoint, or null when no HTTP response was received (for example, the request timed out or TLS negotiation failed).
attempts[].created_at
string
Timestamp when the delivery attempt was made.