HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Webhook Endpoint

Registra un webhook endpoint para la organización autenticada.

Si ya existe un endpoint con la misma URL para la organización, se actualiza en lugar de crear uno nuevo. Devuelve el endpoint con su ID y su secret. El estado por defecto es enabled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
custom_headers
object
enabled_events
array of strings
required

Eventos a los que se suscribe este endpoint. 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. Declara solo los que tu integración procesa: suscribirse a la lista completa no es lo esperable. Los eventos deprecados no se pueden declarar; un endpoint que ya los tenía los sigue recibiendo, pero mientras los conserve no admite cambios de eventos, URL ni estado.

Show Details
activation.createdSe crea una activación de transferencia (transfer_cl) para una cuenta.
bank_account_verification.resultSe obtiene el resultado de una verificación de cuenta bancaria.
billing_document.createdSe emite un documento tributario (factura o nota) para una deuda.
chargeback.status_updateCambia el estado de un contracargo.
checkout_session.accessedEl pagador accede a una sesión de checkout.
checkout_session.expiredUna sesión de checkout expira.
client_bank_movements.bulk_createdSe registran movimientos bancarios nuevos en una cuenta bancaria de la organización; llegan agrupados en envíos de hasta 500 movimientos.
customer.createdSe crea un cliente.
customer.deletedSe elimina un cliente.
customer.updatedSe actualiza un cliente.
debt_reconciliation.reconciledUna reconciliación de deuda pasa a estado APPROVED o MANUALLY_RECONCILED.
document.canceledSe cancela un documento de firma electrónica.
document.failedFalla la firma de un documento de firma electrónica.
document.signedSe firma un documento de firma electrónica.
interaction.incomingSe recibe una interacción entrante de un cliente (mensaje o correo).
invoice.createdSe crea una deuda (invoice).
invoice.paidSe paga una deuda.
invoice.refundSe reembolsa una deuda.
invoice.updatedSe actualiza una deuda.
invoice.voidedSe anula una deuda.
invoice_restructuring.completedUna reestructuración de facturas completa sus after-actions: se crean las nuevas facturas y se anulan las originales.
operation_receipt.createdSe crea un comprobante de operación.
payment_instrument.createdSe crea un instrumento de pago.
payment_instrument.updatedSe actualiza un instrumento de pago.
payment_method.attachedSe asocia un medio de pago a un cliente.
payment_method.attached_productsSe asocian productos a un medio de pago existente.
payment_method.deletedSe elimina un medio de pago.
payment_method.status_updateCambia el estado de un medio de pago.
payment_method.updatedSe actualizan los datos de un medio de pago.
payment_method_inscription_intent.failedFalla un intento de inscripción de medio de pago.
payout.doneSe completa el payout (depósito) del dinero conciliado de una cuenta en Chile.
payout_br.successO payout (depósito) de uma conta no Brasil é concluído com sucesso.
payout_mx.successSe completa con éxito el payout (depósito) de una cuenta en México.
rendition_file.createdSe crea un archivo de rendición.
rendition_file.successUn archivo de rendición se procesa con éxito.
rendition_file.uploadedSe sube un archivo de rendición.
subscription.createdSe crea una suscripción.
subscription.deletedSe elimina una suscripción.
subscription.updatedSe actualiza una suscripción.
transaction.bulk_failedUn lote de transacciones falla.
transaction.bulk_successUn lote de transacciones se procesa con éxito.
transaction.capture_pendingUna transacción queda autorizada y a la espera de captura.
transaction.failedFalla un intento de cobro de una transacción.
transaction.refundUna transacción se reembolsa (total o parcialmente).
transaction.renewedUna transacción recurrente se renueva para un nuevo período.
transaction.status_updateCambia el estado de una transacción.
transaction.successSe autoriza/captura una transacción y queda en estado exitoso (pagada).
transaction_external.successUna transacción procesada externamente se reporta como exitosa.
validator_execution.resultUna validación de riesgo cierra, sea porque llegó a un veredicto o porque se agotaron los intentos del cliente.
enabled_events*
string
enum

Si el Webhook Endpoint está recibiendo eventos.

Un endpoint nace enabled, y ese es el único estado en que Toku le entrega los eventos a los que está suscrito. Pasarlo a disabled lo deja registrado con su configuración intacta, pero además de cortar las entregas nuevas abandona las que estaban pendientes de reintento: no se acumulan para enviarlas al volver a habilitarlo.

Allowed:
uri
required
length between 1 and 2083
date
Responses

400

Evento deprecado no permitido o forma inválida de filter_dimensions.

422

Payload inválido, dimensión de filtro no aceptada o más de un evento habilitado.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json