TRtrytoku
Webhook Endpoints

Editar Webhook Endpoint

Actualiza la configuración de un webhook endpoint existente de la organización.

Solo modifica los campos incluidos en la solicitud; el resto conserva su valor actual. Si cambia la URL o los eventos, ningún otro endpoint de la URL resultante puede recibir uno de esos eventos. Devuelve el endpoint ya actualizado.

put/webhook_endpoints/{webhook_endpoint_id}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/webhook_endpoints/{webhook_endpoint_id}
  • Auth
    API key in header x-api-key

Path parameters

webhook_endpoint_idstring required

Identificador del Webhook Endpoint.

Request body

custom_headersobject
enabled_eventsstring[]

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.

status'enabled' | 'disabled'

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.

urlstring uri
webhook_versionstring date

Response

Successful Response

custom_headers_keysstring[]

Nombres de los encabezados personalizados configurados; sus valores nunca se exponen.

enabled_eventsstring[] required

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.

idstring required

Identificador del Webhook Endpoint.

secretstring required

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

status'enabled' | 'disabled'

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.

urlstring uri required

URL de destino a la que se entregan los webhooks.

webhook_versionstring date

Versión del contrato de payload que usa el endpoint.

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.