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

Exportar todas las entregas webhook como CSV o XLSX

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

Descarga el historial de entregas de todos los endpoints de la cuenta de usuario en un archivo, con los mismos filtros que el listado: endpoint, estado y tipo de evento.

El formato se elige con ?format —csv por defecto, xlsx como alternativa— y el tope es de 100 000 filas, que ?limit puede bajar.

Conviene exportar antes de borrar un endpoint: DELETE /v1/webhooks/{id} se lleva su historial por delante y no hay forma de recuperarlo.

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
formatquerystringopcional

Formato del archivo a descargar. Valores aceptados: csv y xlsx. Cualquier otro valor se sirve como csv.

Predeterminado: csv

p. ej. csv
limitqueryintegeropcional

Filtro — Recorta el número de filas del archivo. Solo baja el tope: un valor mayor que 100 000, o menor que 1, deja el tope por defecto.

p. ej. 500
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/export' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuestaGET /v1/webhooks/deliveries/export
CódigoClaseDescripciónCuerpo
2002xxArchivo CSV o XLSX con el historial consolidado de entregas de todos los endpoints webhook (hasta 100 000 filas).Cuerpo sin schema
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4294xxLímite de tasa excedidoErrorResponse
Errores de GET /v1/webhooks/deliveries/export
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`).