Skip to main content
POST
Send a test webhook delivery

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

webhook
integer
required

Endpoint id.

Body

application/json
event
string

Event type to stamp on the test payload. Defaults to message.sent.

Example:

"message.delivered"

Response

Test delivery queued.

queued
boolean
required
Example:

true

event
string
required
Example:

"message.delivered"

id
string
required

Stable event id for this test payload (evt_test_…).

Example:

"evt_test_9f8b1c2d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"