v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List events

List the webhook events generated for your provider. Filter by webhook_config, company, topic, status, and a created_after/created_before (ISO-8601) time range.

get/events

Query parameters

webhook_configstring

Return events for this webhook config.

companystring

Return events for this company.

topicstring

Return events with this webhook topic.

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

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

created_afterstring date-time

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

created_beforestring date-time

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

limitinteger

Number of events returned per page. The maximum value is 100.

Response

200

{"stackTrail":"paths:/events:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/events:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "results": [
    {
      "id": "whe_7uCODm8JFmZyov9jL8QO",
      "webhook_config": "whc_7uCODm8JFmZyov9jL8QO",
      "company": "com_zH8Gq33iBkFj5o0GKjTw",
      "topic": "payroll",
      "status": "delivered",
      "created_at": "2024-01-19T17:04:15Z",
      "delivery_attempts": [
        {
          "status_code": 200,
          "created_at": "2024-01-19T17:04:15Z"
        }
      ]
    }
  ]
}