Registrar un webhook

Registra un endpoint que recibirá los eventos de tu compañía por POST, en vez
de que tengas que consultar el estado de cada documento.

DGMax verifica tu endpoint antes de aceptarlo. Ejecuta la autenticación que
declaraste en auth (incluido el token dance de OAuth2) y envía un ping firmado
de tipo webhook.verification. Si las credenciales son inválidas o el endpoint
no responde 2xx, el registro se rechaza con 422 y no se guarda nada. Una
credencial mal configurada se detecta al momento, no la primera vez que se cae
una notificación real.

La respuesta incluye una sola vez el signing_secret. Es el secret key con
el que verificas la cabecera X-DGMax-Signature de cada entrega; no se vuelve
a mostrar.

Límites por compañía: hasta
5 endpoints por evento y
20 en total. Al alcanzar un tope
la operación responde 409.

Entrega y reintentos

Responde 2xx lo antes posible; encola el trabajo pesado. DGMax trata
cualquier 2xx como entrega exitosa.

Tu respuestaQué hace DGMax
2xxEntrega DELIVERED. Reinicia el contador de fallos.
3xxFallo permanente (no seguimos redirecciones). Registra la URL final.
4xxFallo permanente (firma, payload o URL que tú rechazas). No reintenta.
5xx, timeout o error de conexiónFallo transitorio. Reintenta.

Cuándo desistimos. Una entrega transitoria se reintenta hasta
5 veces después del intento inicial
(6 intentos en total), con backoff
exponencial que arranca en ~1 segundo y se topa en 5 minutos. Agotados los
intentos, la entrega queda en FAILED y no se vuelve a enviar: ese evento
se pierde para tu endpoint, y debes reconciliar por API los documentos que no
recibiste.

Auto-desactivación. Si un endpoint acumula
20 fallos consecutivos, DGMax lo
desactiva (active: false, disabled_reason: consecutive_failures) para dejar
de golpear un destino caído. Reactívalo con PATCH cuando lo arregles: eso
reinicia el contador.

Idempotencia. La entrega es al menos una vez. Cada transición final
produce un event_id determinista, también enviado en X-DGMax-Event-Id.
Úsalo como idempotency key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Payload to register a new webhook endpoint.

boolean
Defaults to true

Registra el endpoint pausado si lo envias en false.

auth

Como DGMax se autentica ante tu endpoint. Independiente de la firma HMAC, que siempre se envía.

string
length ≤ 255

Nota libre para identificarlo.

event_types
array of objects
required
length ≥ 1

Eventos a los que se suscribe este endpoint. Debe traer al menos uno.

Event Types*
Allowed:
string
required
length ≤ 2048

URL publica que recibirá los POST; en produccion debe ser HTTPS. DGMax rechaza direcciones privadas, de loopback, link-local y de metadata de nube (protección SSRF), tanto al registrar como en cada entrega.

Responses

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