Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like 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-07-20"

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).

Response

test event sent

body
any
required

The body of the webhook response.

status
integer
required

The HTTP response code of this request.

success
boolean
required

Whether or not the webhook test was successful.