Objeto Webhook Endpoint

Destino al que Toku entrega los webhooks.

Los endpoints se registran por organización, no por Customer: cada evento se entrega a todos los endpoints que estén habilitados y suscritos a ese tipo de evento, de modo que varios pueden recibir el mismo aviso.

Atributos

custom_headers_keys array of string
Nombres de los encabezados personalizados configurados; sus valores nunca se exponen.

enabled_events array of string
Tipos de evento que este endpoint recibe. El nombre es siempre recurso.evento: los que terminan en .status_update avisan cualquier cambio de estado del recurso y los específicos, como invoice.paid, una transición concreta; los que llevan bulk resumen una operación masiva en un solo envío en lugar de uno por registro.

Valores posibles: interaction.incoming, interaction.outgoing, payment.succeeded, payment_method.attached, payment_method.attached_products, payment_method.deleted, payment_method.status_update, payment_method.updated, payment_instrument.created, payment_instrument.updated, payment_intent.succeeded, payment_intent.payment_failed, payment_intent.succeeded_batch, payment_intent.payment_failed_batch, payment_intent.payment_pending_batch, payment_intent.status_update, payout.done, payout_mx.success, payout_br.success, activation.created, ….

filter_dimensions object
Filtros por dimensión que acotan qué eventos se entregan a este endpoint.

id string
Identificador público del webhook endpoint.

secret string
Secreto compartido con el que se firman los envíos para verificar su origen.

status string
Estado del endpoint: habilitado o deshabilitado.

Valores posibles: enabled, disabled.

url string (uri)
URL de destino a la que se entregan los webhooks.

webhook_version string (date)
Versión del contrato de payload que usa el endpoint.

Ejemplo

{
  "custom_headers_keys": [
    "X-Custom-Token"
  ],
  "enabled_events": [
    "transaction.success",
    "transaction.failed"
  ],
  "filter_dimensions": {
    "channel": {
      "quantifier": "any",
      "values": [
        "linkCaja"
      ]
    }
  },
  "id": "whe_R7kPq2mNvB4xC8dF1hJ5tW9sZ3aY",
  "secret": "whesec_L6oI8uY7tR5eW3qA1sD9fG2hJ4kZ",
  "status": "enabled",
  "url": "https://example.com/webhooks/toku",
  "webhook_version": "2024-04-01"
}