Skip to main content
POST
Create webhook

Autorizaciones

X-API-Key
string
header
requerido

Merchant API key for authentication

Cuerpo

application/json
url
string<uri>
requerido

URL to receive webhook events

Required string length: 1 - 2083
events
enum<string>[]
requerido

Event types to subscribe to

Minimum array length: 1
Opciones disponibles:
order.created,
order.status_changed
Ejemplo:
description
string | null

Optional description for this webhook

Maximum string length: 500

Respuesta

Successful Response

id
string
requerido

Webhook endpoint identifier

Ejemplo:

"ep_2bNzYPyBRuC1mMYXXAvgSSuz4Fz"

url
string
requerido

Webhook delivery URL

events
string[]
requerido

Subscribed event types

is_active
boolean
requerido

Whether the webhook is currently active

description
string | null

Webhook description

created_at
string<date-time> | null

Creation timestamp

secret
string | null

Signing secret (only returned on creation)