Skip to main content
POST
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

developer:manage_webhook

Encabezados

Idempotency-Key
string

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

Maximum string length: 255
Ejemplo:

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

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Webhook ID, prefixed hook_.

Cuerpo

application/json
event
string
requerido

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

Ejemplo:

"payment.succeeded"

Respuesta

test event sent

body
any
requerido

The body of the webhook response.

Ejemplo:

"OK"

status
integer
requerido

The HTTP response code of this request.

Ejemplo:

200

success
boolean
requerido

Whether or not the webhook test was successful.

Ejemplo:

true