Webhooks
Preview recent events for a webhook endpoint
Returns a sample of recent events matching the endpoint's subscribed event types and filters, without sending any deliveries. Useful for validating filter patterns. Administrator access only.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Webhook endpoint UUID.
Query Parameters
filter[since]?string
Only consider events newer than this timestamp. Defaults to 7 days ago. An unparseable value yields a 422.
Optional override of the endpoint's stored per-event-type filter patterns, keyed by event type.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhook/endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/preview_events" \ -H "Content-Type: application/json" \ -d '{}'{ "data": [ { "id": "string", "type": "event_preview", "attributes": { "event_type": "string", "payload": {}, "occurred_at": "2019-08-24T14:15:22Z" } } ], "meta": { "since": "2019-08-24T14:15:22Z", "total_matching": 0, "total_events": 0, "date_range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}