Skip to main content
GET
Node.js

Headers

X-Api-Key
string
required

Query Parameters

created_after
string

Inclusive lower bound(UTC) for filtering webhook batches by creation time. Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ

created_before
string

Exclusive upper bound(UTC) for filtering webhook batches by creation time. Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ

statuses
enum<string>[]

Filters webhook batches by webhook response status category. Values must be unique and encoded as a comma-separated list in the query string. If not provided, batches with all categories are returned.

Maximum array length: 6
Available options:
1xx,
2xx,
3xx,
4xx,
5xx,
no_response
webhook
string

Filters webhook batches by the webhook endpoint to which events in the batch were posted.

limit
integer
default:500

The maximum number of webhook batches to return

Required range: 1 <= x <= 500
offset
integer
default:0

The number of webhook batches to skip before starting to collect the result set

Required range: x >= 0

Response

Successfully returned Webhook batches

webhook_batches
object[]
required

List of webhook batches matching the filter. Empty if no webhook batches match the filter.