HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos principales
  2. Webhook Endpoints

Crear Webhook Endpoint

post
https://api.trytoku.com/webhook_endpoints

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 objects
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.

enabled_events*
string

Object mapping each dimension name to {"values": [str, ...], "quantifier": "any"|"all"}. Validated server-side; malformed shapes return HTTP 400.

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
Headers
string

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

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.

Updated 5 days ago

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

Updated 5 days ago

Did this page help you?