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

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Headers

Idempotency-Key
string

Unique key that makes this request safe to retry. Replaying the key with the same body returns the original response with Idempotent-Replayed: true; replaying it with a different body returns 409 idempotency.key_conflict.

Required string length: 1 - 255
Example:

"a1b2c3d4-0000-4000-8000-000000000000"

Path Parameters

endpoint_id
string<uuid>
required
Example:

"8e1a7f50-90ab-4cde-8012-3456789abcde"

Body

application/json
event_type
string
required

A type from the event catalog; its example payload is delivered.

Minimum string length: 1
Example:

"example.updated"

Response

The test event and its first delivery attempt.

event
object
required
attempt
object
required