Webhooks

Enviar Webhook de prueba

Changed on

Envía un webhook de prueba a una URL para validar la configuración de webhooks.

Se usa desde el panel para comprobar que un endpoint recibe correctamente los webhooks, generando un evento de ejemplo del tipo indicado. Está obsoleto y se mantiene solo por compatibilidad.

post/dummy_webhook

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/dummy_webhook
  • Auth
    API key in header x-api-key

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

event_type'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' required

Evento del que Toku avisa por webhook: qué recurso cambió y qué le pasó.

El 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 o 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.

urlstring required

Example request

{
  "event_type": "transaction.success",
  "url": "https://example.com/webhooks/toku"
}

Response

Successful Response

event_typestring required

Tipo del evento de prueba que se despachó.

idstring required

Identificador público del webhook de prueba generado.

urlstring required

URL de destino a la que se envió el webhook de prueba.

Example response

{
  "event_type": "transaction.success",
  "id": "wheve_9Kd3pQ2rLm7xNvB4tYc1Zs8HfW0aE6uJ3Fb9Kd0aLm7=",
  "url": "https://example.com/webhooks/toku"
}

Changes

    • breaking

      request body became required

    • breaking

      request property was restricted to a list of enum values

    • breaking

      added the pattern (https?:\/\/(www\.)?)[-a-zA-Z0-9@:%._\+~#=]{1,256}(\.[a-zA-Z0-9()]{1,6}|:[0-9]{4})\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*) to the request property

    • info

      api operation id probar-webhook removed and replaced with dummy_webhook

    • info

      api tag Webhooks added

    • info

      endpoint deprecated

    • info

      added the new optional header request parameter x-account-key

    • info

      added the new activation.created enum value to the request property

    • info

      added the new bank_account_verification.result enum value to the request property

    • info

      added the new billing_document.created enum value to the request property

    • info

      added the new chargeback.status_update enum value to the request property

    • info

      added the new checkout_session.accessed enum value to the request property

    • info

      added the new checkout_session.expired enum value to the request property

    • info

      added the new client_bank_movements.bulk_created enum value to the request property

    • info

      added the new customer.created enum value to the request property

    • info

      added the new customer.deleted enum value to the request property

    • info

      added the new customer.updated enum value to the request property

    • info

      added the new debt_reconciliation.reconciled enum value to the request property

    • info

      added the new document.canceled enum value to the request property

    • info

      added the new document.failed enum value to the request property

    • info

      added the new document.signed enum value to the request property

    • info

      added the new interaction.incoming enum value to the request property

    • info

      added the new invoice.created enum value to the request property

    • info

      added the new invoice.paid enum value to the request property

    • info

      added the new invoice.refund enum value to the request property

    • info

      added the new invoice.updated enum value to the request property

    • info

      added the new invoice.voided enum value to the request property

    • info

      added the new invoice_restructuring.completed enum value to the request property

    • info

      added the new operation_receipt.created enum value to the request property

    • info

      added the new payment_instrument.created enum value to the request property

    • info

      added the new payment_instrument.updated enum value to the request property

    • info

      added the new payment_method.attached_products enum value to the request property

    • info

      added the new payment_method.deleted enum value to the request property

    • info

      added the new payment_method.status_update enum value to the request property

    • info

      added the new payment_method.updated enum value to the request property

    • info

      added the new payment_method_inscription_intent.failed enum value to the request property

    • info

      added the new payout.done enum value to the request property

    • info

      added the new payout_br.success enum value to the request property

    • info

      added the new payout_cl.success enum value to the request property

    • info

      added the new payout_mx.success enum value to the request property

    • info

      added the new rendition_file.created enum value to the request property

    • info

      added the new rendition_file.success enum value to the request property

    • info

      added the new rendition_file.uploaded enum value to the request property

    • info

      added the new subscription.created enum value to the request property

    • info

      added the new subscription.deleted enum value to the request property

    • info

      added the new subscription.updated enum value to the request property

    • info

      added the new transaction.bulk_failed enum value to the request property

    • info

      added the new transaction.bulk_success enum value to the request property

    • info

      added the new transaction.capture_pending enum value to the request property

    • info

      added the new transaction.failed enum value to the request property

    • info

      added the new transaction.refund enum value to the request property

    • info

      added the new transaction.renewed enum value to the request property

    • info

      added the new transaction.status_update enum value to the request property

    • info

      added the new transaction.success enum value to the request property

    • info

      added the new transaction_external.success enum value to the request property

    • info

      added the new validator_execution.result enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status