POST
Send a test event

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Headers

Idempotency-Key
string
required

Unique key for this operation. Retries with the same key return the first result.

Maximum string length: 255
Example:

"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"

Path Parameters

id
string<uuid>
required

Body

application/json
type
enum<string>
required

New event types may be added. Ignore types you don't handle.

Available options:
checkout_session.expired,
escrow.funded,
milestone.delivered,
milestone.released,
escrow.completed,
escrow.refunded,
dispute.opened,
dispute.evidence_requested,
dispute.evidence_submitted,
dispute.resolved,
payout.sent,
refund.sent,
refund.failed,
chargeback.opened,
chargeback.closed,
payout.failed

Response

What your endpoint answered

object
string
required
Allowed value: "webhook_test_result"
event_id
string
required
Example:

"evt_test_8f2a1c"

delivered
boolean
required

True when your endpoint answered 2xx within 10 seconds

status_code
integer | null
required
Example:

200

response_ms
integer | null
required
Example:

184

error
string | null
required

Why it failed, when no status code came back (timeout, TLS, DNS)

Example:

null