Skip to main content
POST
Crear webhook

Authorizations

x-api-key
string
header
required

Body

application/json
url
string<uri>
required

URL a la que Trebol enviará las notificaciones

Example:

"https://example.com/webhooks/trebol"

events
string[]
required

Lista de eventos a suscribir

Example:
description
string | null
Example:

"Webhook principal de producción"

Response

Webhook creado exitosamente.

id
string

ID único del webhook

Example:

"wh_123"

url
string<uri>

URL a la que Trebol enviará las notificaciones

Example:

"https://example.com/webhooks/trebol"

events
string[]

Lista de eventos suscritos

status
enum<string>

Indica si el webhook está habilitado o deshabilitado. Al crear el webhook, el status por defecto es "enabled".

Available options:
enabled,
disabled
Example:

"enabled"

description
string | null

Descripción opcional del webhook

secret
string

Secreto del webhook. Se asigna una vez que se crea el webhook y solo se muestra una vez.

Example:

"whsec_XXXXXXXXXXXXXXXXXXXXXXXX"

created_at
string<date-time>
updated_at
string<date-time>