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.

Maximum string length: 256

Path Parameters

webhookId
string
required

Response

Test delivery created

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

event
object
required

The webhook body for this delivery, rendered as the current webhook format. attempts[].requestBody holds the body each attempt sent, cut off at 64 KiB when requestBodyTruncated is set.

id
string
Example:

"whd_01H9Xa8F5dN6mP3q"

object
string
Example:

"webhookDelivery"

webhookId
string
Example:

"whk_01H9Xa8F5dN6mP3q"

resourceType
string | null
resourceId
string | null
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>
failedAttempts
integer
test
boolean

True for a synthesized test delivery.

createdAt
string<date-time>

When OMS stored the delivery.