WebhookEndpointPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-webhook-endpoint-payload-schema.json",
  "title": "WebhookEndpointPayload",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-recursos-secundarios-api-openapi.yml#/components/schemas/WebhookEndpointPayload",
  "properties": {
    "custom_headers": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Custom Headers",
      "type": "object"
    },
    "enabled_events": {
      "description": "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`](/reference/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.",
      "items": {
        "description": "Evento del que Toku avisa por webhook: qué recurso cambió y qué le pasó.\n\nEl nombre es siempre `recurso.evento`: el recurso es la entidad que cambió (`invoice`, `transaction`, `payment_method`, `customer`, `subscription`, …) y el evento, lo que le pasó. Los que terminan en `.status_update` avisan cualquier cambio de estado del recurso, mientras que los específicos, como [`invoice.paid`](/reference/invoice-paid) o [`transaction.failed`](/reference/transaction-failed), avisan una transición concreta; los que llevan `bulk` resumen una operación masiva en un solo envío en lugar de uno por registro.",
        "enum": [
          "interaction.incoming",
          "payment_method.attached_products",
          "payment_method.deleted",
          "payment_method.status_update",
          "payment_method.updated",
          "payment_instrument.created",
          "payment_instrument.updated",
          "payout.done",
          "payout_mx.success",
          "payout_br.success",
          "payout_cl.success",
          "activation.created",
          "payment_method_inscription_intent.failed",
          "bank_account_verification.result",
          "invoice.created",
          "invoice.updated",
          "invoice.voided",
          "invoice.refund",
          "invoice.paid",
          "invoice_restructuring.completed",
          "subscription.created",
          "subscription.updated",
          "subscription.deleted",
          "customer.created",
          "customer.updated",
          "customer.deleted",
          "transaction.success",
          "transaction.failed",
          "transaction.capture_pending",
          "transaction.renewed",
          "transaction.refund",
          "transaction.bulk_success",
          "transaction.bulk_failed",
          "transaction.status_update",
          "chargeback.status_update",
          "transaction_external.success",
          "document.signed",
          "document.canceled",
          "document.failed",
          "rendition_file.created",
          "rendition_file.uploaded",
          "rendition_file.success",
          "checkout_session.expired",
          "checkout_session.accessed",
          "billing_document.created",
          "operation_receipt.created",
          "validator_execution.result",
          "debt_reconciliation.reconciled",
          "client_bank_movements.bulk_created"
        ],
        "type": "string",
        "x-enumDescriptions": {
          "activation.created": "Se crea una activación de transferencia (transfer_cl) para una cuenta.",
          "bank_account_verification.result": "Se obtiene el resultado de una verificación de cuenta bancaria.",
          "billing_document.created": "Se emite un documento tributario (factura o nota) para una deuda.",
          "chargeback.status_update": "Cambia el estado de un contracargo.",
          "checkout_session.accessed": "El pagador accede a una sesión de checkout.",
          "checkout_session.expired": "Una sesión de checkout expira.",
          "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.",
          "customer.created": "Se crea un cliente.",
          "customer.deleted": "Se elimina un cliente.",
          "customer.updated": "Se actualiza un cliente.",
          "debt_reconciliation.reconciled": "Una reconciliación de deuda pasa a estado APPROVED o MANUALLY_RECONCILED.",
          "document.canceled": "Se cancela un documento de firma electrónica.",
          "document.failed": "Falla la firma de un documento de firma electrónica.",
          "document.signed": "Se firma un documento de firma electrónica.",
          "interaction.incoming": "Se recibe una interacción entrante de un cliente (mensaje o correo).",
          "invoice.created": "Se crea una deuda (invoice).",
          "invoice.paid": "Se paga una deuda.",
          "invoice.refund": "Se reembolsa una deuda.",
          "invoice.updated": "Se actualiza una deuda.",
          "invoice.voided": "Se anula una deuda.",
          "invoice_restructuring.completed": "Una reestructuración de facturas completa sus after-actions: se crean las nuevas facturas y se anulan las originales.",
          "operation_receipt.created": "Se crea un comprobante de operación.",
          "payment_instrument.created": "Se crea un instrumento de pago.",
          "payment_instrument.updated": "Se actualiza un instrumento de pago.",
          "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_method_inscription_intent.failed": "Falla un intento de inscripción de medio de pago.",
          "payout.done": "Se completa el payout (depósito) del dinero conciliado de una cuenta en Chile.",
          "payout_br.success": "O payout (depósito) de uma conta no Brasil é concluído com sucesso.",
          "payout_cl.success": "Se completa con éxito el payout (depósito) de una cuenta en Chile, con el detalle de sus transacciones.",
          "payout_mx.success": "Se completa con éxito el payout (depósito) de una cuenta en México.",
          "rendition_file.created": "Se crea un archivo de rendición.",
          "rendition_file.success": "Un archivo de rendición se procesa con éxito.",
          "rendition_file.uploaded": "Se sube un archivo de rendición.",
          "subscription.created": "Se crea una suscripción.",
          "subscription.deleted": "Se elimina una suscripción.",
          "subscription.updated": "Se actualiza una suscripción.",
          "transaction.bulk_failed": "Un lote de transacciones falla.",
          "transaction.bulk_success": "Un lote de transacciones se procesa con éxito.",
          "transaction.capture_pending": "Una transacción queda autorizada y a la espera de captura.",
          "transaction.failed": "Falla un intento de cobro de una transacción.",
          "transaction.refund": "Una transacción se reembolsa (total o parcialmente).",
          "transaction.renewed": "Una transacción recurrente se renueva para un nuevo período.",
          "transaction.status_update": "Cambia el estado de una transacción.",
          "transaction.success": "Se autoriza/captura una transacción y queda en estado exitoso (pagada).",
          "transaction_external.success": "Una transacción procesada externamente se reporta como exitosa.",
          "validator_execution.result": "Una validación de riesgo cierra, sea porque llegó a un veredicto o porque se agotaron los intentos del cliente."
        },
        "x-toku-webhook-pages": {
          "activation.created": "activation-created",
          "bank_account_verification.result": "bank-account-verification-result",
          "billing_document.created": "billing-document-created",
          "chargeback.status_update": "chargeback-status-update",
          "checkout_session.accessed": "checkout-session-accessed",
          "checkout_session.expired": "checkout-session-expired",
          "client_bank_movements.bulk_created": "client-bank-movements-bulk-created",
          "customer.created": "customer-created",
          "customer.deleted": "customer-deleted",
          "customer.updated": "customer-updated",
          "debt_reconciliation.reconciled": "debt-reconciliation-reconciled",
          "document.canceled": "document-canceled",
          "document.failed": "document-failed",
          "document.signed": "document-signed",
          "interaction.incoming": "interaction-incoming",
          "invoice.created": "invoice-created",
          "invoice.paid": "invoice-paid",
          "invoice.refund": "invoice-refund",
          "invoice.updated": "invoice-updated",
          "invoice.voided": "invoice-voided",
          "invoice_restructuring.completed": "invoice-restructuring-completed",
          "operation_receipt.created": "operation-receipt-created",
          "payment_instrument.created": "payment-instrument-created",
          "payment_instrument.updated": "payment-instrument-updated",
          "payment_method.attached_products": "payment-method-attached-products",
          "payment_method.deleted": "payment-method-deleted",
          "payment_method.status_update": "payment-method-status-update",
          "payment_method.updated": "payment-method-updated",
          "payment_method_inscription_intent.failed": "payment-method-inscription-intent-failed",
          "payout.done": "payout-done",
          "payout_br.success": "payout-br-success",
          "payout_cl.success": "payout-cl-success",
          "payout_mx.success": "payout-mx-success",
          "rendition_file.created": "rendition-file-created",
          "rendition_file.success": "rendition-file-success",
          "rendition_file.uploaded": "rendition-file-uploaded",
          "subscription.created": "subscription-created",
          "subscription.deleted": "subscription-deleted",
          "subscription.updated": "subscription-updated",
          "transaction.bulk_failed": "transaction-bulk-failed",
          "transaction.bulk_success": "transaction-bulk-success",
          "transaction.capture_pending": "transaction-capture-pending",
          "transaction.failed": "transaction-failed",
          "transaction.refund": "transaction-refund",
          "transaction.renewed": "transaction-renewed",
          "transaction.status_update": "transaction-status-update",
          "transaction.success": "transaction-success",
          "transaction_external.success": "transaction-external-success"
        }
      },
      "type": "array"
    },
    "status": {
      "$ref": "#/$defs/constants__webhook_endpoint__WebhookStatus"
    },
    "url": {
      "format": "uri",
      "maxLength": 2083,
      "minLength": 1,
      "title": "Url",
      "type": "string"
    },
    "webhook_version": {
      "format": "date",
      "title": "Webhook Version",
      "type": "string"
    }
  },
  "required": [
    "enabled_events",
    "url"
  ],
  "type": "object",
  "$defs": {
    "constants__webhook_endpoint__WebhookStatus": {
      "description": "Si el Webhook Endpoint está recibiendo eventos.\n\nUn 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.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "title": "WebhookStatus",
      "type": "string"
    }
  }
}