Skip to main content
POST
Send a test event to a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Required. At most 255 characters of valid UTF-8 with no NUL byte; a missing key is refused with 400 idempotency_key_required and a malformed one with 400 invalid_idempotency_key. A retry with the same key and body returns the original successful response for 24 hours; a request that failed can be sent again under the same key. The same key with a different body is refused with 409 idempotency_key_conflict, and while the first request is still running with 409 idempotency_key_in_progress and a Retry-After header.

Required string length: 1 - 255

Path Parameters

id
string
required
Pattern: ^whs_[A-Za-z0-9_-]+$

Body

application/json

Optional. Without event_type, or with it null, the operation sends webhook.test. Other fields are ignored.

event_type
string | null

The event type to send: webhook.test (the default, also sent for null) or any type whose sent is true in the event-type list. It arrives with that type, version and source, its body filled with generated example data whose business.id is your own, and with "test": true as the envelope's last field. Never fulfil an order, grant access or book anything for an event whose envelope says test: true. A test delivery cannot be replayed; send a new test.

Response

Webhook test event delivery result

data
object
required