Skip to main content
POST
Send a test delivery

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

Client-supplied request key. Required on all non-auth POST requests.

Path Parameters

webhookId
string
required

Response

Test delivery created

One delivery of one event to one webhook. The id is the partner-facing envelope id and dedup key, stable across retries.

id
string
Example:

"whd_01H9Xa8F5dN6mP3q"

object
string
Example:

"webhookDelivery"

webhookId
string
Example:

"whk_01H9Xa8F5dN6mP3q"

eventType
string
Example:

"transaction.settled"

eventId
string
Example:

"evt_01H9Xa8F5dN6mP3q"

resourceType
string | null
resourceId
string | null
sequence
integer<int64> | null

Per-resource monotonic counter for consumer-side reordering/gap detection.

status
enum<string>

Delivery lifecycle state. skipped is recorded but not dispatched (suspended/disabled webhook).

Available options:
queued,
inProgress,
delivered,
failed,
skipped
statusReason
string | null
sendAt
string<date-time>
deliveredAt
string<date-time> | null
occurredAt
string<date-time> | null
failedAttempts
integer
payload
object

Domain payload of the event, before envelope wrap.

test
boolean

True for a synthesized test delivery.

createdAt
string<date-time>