Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Query Parameters

event_type
string

The event type to send as a test

Response

The receiver's response to the test event

delivered
boolean
required

Whether the receiver answered with a 2xx status

response_code
integer
required

The HTTP status the receiver returned

response_body
string
required

The body the receiver returned, truncated to 10,000 characters

message
string
required