CHcheckhq

List webhook deliveries

Changed on

List the webhook deliveries generated for your provider. Filter by webhook config, company, topic, status, and created time range.

get/webhook_deliveries

Request

Query parameters

webhook_configstring

Return webhook deliveries for this webhook config.

companystring

Return webhook deliveries for this company.

topicstring

Return webhook deliveries with this webhook topic.

status'pending' | 'retrying' | 'delivered' | 'failed'

Return webhook deliveries with this delivery status (pending, retrying, delivered, or failed).

created_afterstring date-time

Return webhook deliveries created on or after the provided datetime (ISO-8601).

created_beforestring date-time

Return webhook deliveries created on or before the provided datetime (ISO-8601).

limitinteger

Number of webhook deliveries returned per page. The maximum value is 100.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

nextunknown
previousunknown

Example response

{
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}

Changes