Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
WebhookEvent

Get overview aggregates for webhook events

Get overview aggregates for webhook events including success/failure rates

get/api/v2/webhook-events/summary

Query parameters

fromstring date
Example:2024-01-01

Inclusive start of the window (YYYY-MM-DD).

tostring date
Example:2024-01-31

Inclusive end of the window (YYYY-MM-DD).

Response

Default Response

total_eventsnumber required

Total number of webhook events

successful_eventsnumber required

Total number of successful webhook events

failed_eventsnumber required

Total number of failed webhook events

success_ratenumber required

Percentage (0-100) of successful webhook calls

failure_ratenumber required

Percentage (0-100) of failed webhook calls

Example response

{
  "total_events": 100,
  "successful_events": 100,
  "failed_events": 100,
  "success_rate": 50,
  "failure_rate": 50
}