Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id
string
required

Webhook ID, prefixed hook_.

Body

application/json
event
string
required

The event to test the webhook for, in dot form (for example payment.succeeded).

Example:

"payment.succeeded"

Response

test event sent

body
any
required

The body of the webhook response.

Example:

"OK"

status
integer
required

The HTTP response code of this request.

Example:

200

success
boolean
required

Whether or not the webhook test was successful.

Example:

true