GEThttps://api.veriko.mx/v1/webhooks/deliveries

Listar entregas de todos los endpoints webhook

Audiencia
public
Autenticación
API key
Permiso
webhooks:read
Guía de uso →

Devuelve una vista consolidada de las entregas hechas a los endpoints webhook del usuario autenticado.

Se puede filtrar por endpoint, estado y tipo de evento.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
endpoint_idquerystring (uuid)opcional

Filtro — Identificador único del endpoint webhook (UUID v4).

p. ej. 7c9e6679-7425-40de-944b-e07fc1f90ae7
event_typequerystringopcional

Filtro — Tipo de evento que originó la entrega. De validaciones: validation.completed cuando hay veredicto de Banxico, sea cual sea (también inválida o no encontrada, y aunque se abran reintentos), validation.failed cuando la entrada se rechaza y validation.error ante cualquier otro fallo. De los reintentos automáticos: validation.retry.scheduled al programar un reintento automático, validation.retry.resolved cuando un reintento automático encuentra el CEP, y validation.retry.exhausted cuando los reintentos se agotan sin encontrar el CEP. De la revisión posterior de un valid: validation.returned cuando una validación que había salido valid pasa a returned porque Banxico reportó la devolución.
De la suscripción: billing.payment_succeeded y billing.payment_failed por cada cobro, billing.invoice_upcoming antes de la siguiente factura, billing.trial_will_end antes de que acabe la prueba gratuita, y billing.subscription_canceled al cancelar la suscripción. Las entregas sintéticas (envío de prueba) se marcan como test.

p. ej. validation.completed
pagequeryintegeropcional

Filtro — Página que se pide, empezando en 1.

Predeterminado: 1

p. ej. 1
per_pagequeryintegeropcional

Filtro — Cuántas entregas trae cada página.

Predeterminado: 50

p. ej. 50
statusquerystringopcional

Filtro — Estado de la entrega. success llegó. failed es el resultado del último intento; Messenger puede programar otro si el fallo es recuperable. retrying se pospuso por el límite de salida y Messenger la reintentará. pending todavía no se ha intentado.

p. ej. failed
Petición
curl -X GET 'https://api.veriko.mx/v1/webhooks/deliveries' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200WebhookDelivery — Lista consolidada de entregas de todos los endpoints del usuario.
CampoTipoDescripción
type*string

Tipo de recurso JSON:API. Siempre webhook_delivery.

p. ej. webhook_delivery
id*string

Identificador autoincremental de la entrega.

p. ej. 48211
attributes*object

Datos de la entrega webhook (endpoint receptor, intento, respuesta y estado).

endpoint_id*string (uuid)

Identificador único del endpoint webhook (UUID v4) que originó esta entrega.

p. ej. a1b2c3d4-e5f6-7890-abcd-ef0123456789
endpoint_urlstring

URL receptora del webhook (endpoint). Solo presente en el listado global (GET /v1/webhooks/deliveries).

p. ej. https://erp.example.com/hooks/pagos
event_type*string

Tipo de evento que originó la entrega. Determina la forma del cuerpo firmado con HMAC que recibe el receptor. Las entregas sintéticas (envío de prueba) se marcan como test.

p. ej. validation.completed
validation_id*string | nullanulable

Identificador único de la validación (UUID v4) asociada cuando el evento es validation.*. null cuando el evento es otro.

p. ej. a1b2c3d4-e5f6-7890-abcd-ef0123456789
response_status*integer | nullanulable

Código de estado HTTP con el que respondió el endpoint webhook receptor. null cuando la entrega no llegó a establecer respuesta (tiempo de espera agotado o bloqueo).

p. ej. 200
response_body*string | nullanulable

Cuerpo de la respuesta del endpoint webhook receptor, truncado a 500 caracteres.

p. ej. {"ok":true}
response_time_ms*integer | nullanulable

Duración de la petición de entrega (en milisegundos).

p. ej. 184
attempt*integer

Número del intento. 1 es el primer envío; los mayores, reintentos.

p. ej. 1
status*string

Estado actual de la entrega — pending: Aún sin entregar; retrying: Se pospuso por el límite de salida y Messenger la reintentará; success: Entregada; failed: El último intento falló; Messenger puede programar otro si el fallo es recuperable.

p. ej. pending
next_retry_at*TimestampUTC | null

Fecha y hora del próximo reintento persistido, en ISO 8601 UTC. null cuando no hay una fecha almacenada; los reintentos que programa Messenger no persisten esta fecha en la entrega.

error_message*string | nullanulable

Detalle de error del transporte o del bloqueo de la entrega. null cuando no hay un detalle de error, incluso si el receptor respondió con un estado fuera de 2xx.

p. ej. Connection timed out after 10s
created_at*string (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

p. ej. 2026-05-01T05:14:38Z
Códigos de respuestaGET /v1/webhooks/deliveries
CódigoClaseDescripciónCuerpo
2002xxLista consolidada de entregas de todos los endpoints del usuario.WebhookDelivery
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4294xxLímite de tasa excedidoErrorResponse
Errores de GET /v1/webhooks/deliveries
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d
429rate_limit_exceeded

Límite de peticiones excedido. Inténtalo de nuevo en 45 segundos.

Envelope
meta.request_id
f7a8b9c0d1e22e1d0c9b8a7f
Cabeceras de respuesta
  • Retry-After: integer — Segundos a esperar antes de reintentar. Coincide con la ventana de rate-limit del endpoint (típicamente 60s para listas, 1-5s para operaciones idempotentes en vuelo).
  • X-RateLimit-Limit: integer — Límite de solicitudes configurado para este bucket. Se emite en cada 429 y, en la API autenticada, también en las respuestas correctas, donde es el tope por clave del plan de la cuenta.
  • X-RateLimit-Remaining: integer — Solicitudes restantes en la ventana actual. Siempre 0 en el momento del 429; en una respuesta correcta de la API autenticada es lo que queda del tope por clave.
  • X-RateLimit-Reset: integer — Unix epoch absoluto (segundos) en que se reinicia la ventana. Se emite en cada 429, junto con Retry-After, y en las respuestas correctas de la API autenticada. Puede existir sobreescritura por endpoint (p. ej. `rate_limited_login`).