Saltar al contenido principal

Webhook

Los webhooks son endpoints HTTP que reciben notificaciones cuando ocurren eventos en el sistema. Cada webhook puede estar suscrito a uno o más tipos de eventos.

id string

Identificador único del webhook

Example: wh_1B2M2Y8AsgTpgAmY7PhCfg
name string

Nombre del webhook

Example: My Webhook
status string

Estado del webhook. Si el webhook ha fallado en las últimas 24 horas, el estado será failing.

Possible values: [ok, failing]

Example: ok
last_failure_at date-time

Fecha y hora de la última falla del webhook.

Example: 2024-03-20T15:30:00Z
url string

URL donde se enviarán los eventos

Example: https://company.com/your-webhook-endpoint
secret_key string

Clave secreta para verificar la integridad del webhook.

Example: WHzBRgmn6jC1lm377I70mxiCmyRTON+QeH739YF/oXs=
subscriptions string[]

Lista de eventos a los que está suscrito el webhook. Los eventos disponibles están detallados junto a cada recurso bajo la etiqueta EVENT.

TIP: Puedes suscribirte a todos los eventos de un recurso específico usando el wildcard *. Por ejemplo, para suscribirte a todos los eventos de los disclosure_request, puedes suscribirte a disclosure_request.*.

Example: ["*","auth_attempt.*","validation_attempt.*"]
enabled_modes string[]

Lista de modos en los que el webhook está habilitado

Example: ["production","sandbox"]
enabled boolean

Indica si el webhook está habilitado o no

Example: true
created_at date-time

Fecha y hora de creación del webhook

Example: 2024-03-20T15:30:00Z
updated_at date-time

Fecha y hora de la última actualización del webhook

Example: 2024-03-20T15:30:00Z
Webhook
{
  "id": "wh_1B2M2Y8AsgTpgAmY7PhCfg",
  "name": "My Webhook",
  "status": "ok",
  "last_failure_at": "2024-03-20T15:30:00Z",
  "url": "https://company.com/your-webhook-endpoint",
  "secret_key": "WHzBRgmn6jC1lm377I70mxiCmyRTON+QeH739YF/oXs=",
  "subscriptions": [
    "*",
    "auth_attempt.*",
    "validation_attempt.*"
  ],
  "enabled_modes": [
    "production",
    "sandbox"
  ],
  "enabled": true,
  "created_at": "2024-03-20T15:30:00Z",
  "updated_at": "2024-03-20T15:30:00Z"
}