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 (49)

Valor	Descripción
`interaction.incoming`	Se recibe una interacción entrante de un cliente (mensaje o correo).
`payment_method.attached`	Se asocia un medio de pago a un cliente.
`payment_method.attached_products`	Se asocian productos a un medio de pago existente.
`payment_method.deleted`	Se elimina un medio de pago.
`payment_method.status_update`	Cambia el estado de un medio de pago.
`payment_method.updated`	Se actualizan los datos de un medio de pago.
`payment_instrument.created`	Se crea un instrumento de pago.
`payment_instrument.updated`	Se actualiza un instrumento de pago.
`payout.done`	Se completa el payout (depósito) del dinero conciliado de una cuenta en Chile.
`payout_mx.success`	Se completa con éxito el payout (depósito) de una cuenta en México.
`payout_br.success`	O payout (depósito) de uma conta no Brasil é concluído com sucesso.
`activation.created`	Se crea una activación de transferencia (transfer_cl) para una cuenta.
`payment_method_inscription_intent.failed`	Falla un intento de inscripción de medio de pago.
`bank_account_verification.result`	Se obtiene el resultado de una verificación de cuenta bancaria.
`invoice.created`	Se crea una deuda (invoice).
`invoice.updated`	Se actualiza una deuda.
`invoice.voided`	Se anula una deuda.
`invoice.refund`	Se reembolsa una deuda.
`invoice.paid`	Se paga una deuda.
`invoice_restructuring.completed`	Una reestructuración de facturas completa sus after-actions: se crean las nuevas facturas y se anulan las originales.
`subscription.created`	Se crea una suscripción.
`subscription.updated`	Se actualiza una suscripción.
`subscription.deleted`	Se elimina una suscripción.
`customer.created`	Se crea un cliente.
`customer.updated`	Se actualiza un cliente.
`customer.deleted`	Se elimina un cliente.
`transaction.success`	Se autoriza/captura una transacción y queda en estado exitoso (pagada).
`transaction.failed`	Falla un intento de cobro de una transacción.
`transaction.capture_pending`	Una transacción queda autorizada y a la espera de captura.
`transaction.renewed`	Una transacción recurrente se renueva para un nuevo período.
`transaction.refund`	Una transacción se reembolsa (total o parcialmente).
`transaction.bulk_success`	Un lote de transacciones se procesa con éxito.
`transaction.bulk_failed`	Un lote de transacciones falla.
`transaction.status_update`	Cambia el estado de una transacción.
`chargeback.status_update`	Cambia el estado de un contracargo.
`transaction_external.success`	Una transacción procesada externamente se reporta como exitosa.
`document.signed`	Se firma un documento de firma electrónica.
`document.canceled`	Se cancela un documento de firma electrónica.
`document.failed`	Falla la firma de un documento de firma electrónica.
`rendition_file.created`	Se crea un archivo de rendición.
`rendition_file.uploaded`	Se sube un archivo de rendición.
`rendition_file.success`	Un archivo de rendición se procesa con éxito.
`checkout_session.expired`	Una sesión de checkout expira.
`checkout_session.accessed`	El pagador accede a una sesión de checkout.
`billing_document.created`	Se emite un documento tributario (factura o nota) para una deuda.
`operation_receipt.created`	Se crea un comprobante de operación.
`validator_execution.result`	Una validación de riesgo cierra, sea porque llegó a un veredicto o porque se agotaron los intentos del cliente.
`debt_reconciliation.reconciled`	Una reconciliación de deuda pasa a estado APPROVED o MANUALLY_RECONCILED.
`client_bank_movements.bulk_created`	Se registran movimientos bancarios nuevos en una cuenta bancaria de la organización; llegan agrupados en envíos de hasta 500 movimientos.

id string
Identificador 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"
  ],
  "id": "whe_R7kPq2mNvB4xC8dF1hJ5tW9sZ3aY",
  "secret": "whesec_L6oI8uY7tR5eW3qA1sD9fG2hJ4kZ",
  "status": "enabled",
  "url": "https://example.com/webhooks/toku",
  "webhook_version": "2024-04-01"
}