Sign in

v9

OpenAPI 3.1.02026-08-0352108381.8 KB
Webhooks

Get Aggregated Webhook Event Count

Retrieve webhook event counts aggregated by day within a date range, with options to group by delivery status or webhook ID. Use this endpoint to build time-series charts for monitoring webhook performance and reliability.

get/v0/webhooks/events/count

Query parameters

start_datetimestring date-time

Start datetime in ISO format (e.g., 2023-01-01T00:00:00)

Start datetime in ISO format (e.g., 2023-01-01T00:00:00)

end_datetimestring date-time

End datetime in ISO format (e.g., 2023-01-01T23:59:59)

End datetime in ISO format (e.g., 2023-01-01T23:59:59)

timezonestring

IANA timezone string (e.g., 'Europe/Madrid', 'America/New_York')

IANA timezone string (e.g., 'Europe/Madrid', 'America/New_York')

webhook_idinteger nullable

Webhook ID

Webhook ID

group_byWebhookGroupBy[] nullable

Dimensions to group by. Pass multiple values: ?group_by=status&group_by=event_type

Dimensions to group by. Pass multiple values: ?group_by=status&group_by=event_type

Response

Successful Response

period_startstring date-time required

Start of the period.

number_of_eventsinteger

Number of events.

status'IN_PROGRESS' | 'SUCCESS' | 'FAILED' | 'NOT_TRIGGERED'
webhook_idinteger nullable

ID of the webhook.

event_typestring nullable

Event type of the webhook event.

number_of_executionsinteger required

Deprecated: use number_of_events.