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

Exportar todas las entregas 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 en un archivo, con los mismos filtros que el listado: endpoint, estado y tipo de evento. El formato se elige con ?formatcsv 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

Filtra por UUID de endpoint específico (igual que /webhooks/{id}/deliveries).

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

Tipo de evento que originó la entrega. Del ciclo de una validación: validation.completed cuando termina bien, validation.failed cuando termina mal y validation.error cuando se rompe por nuestro lado. Y de sus reintentos automáticos: validation.retry.scheduled al programar uno, validation.retry.resolved cuando un reintento acaba encontrando el comprobante, y validation.retry.exhausted cuando se agotan sin lograrlo. 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, y billing.subscription_canceled al cancelarse.

p. ej. validation.completed
formatquerystringopcional

Formato del archivo. csv por defecto; xlsx produce una hoja de cálculo. Cualquier otro valor se sirve como csv.

Predeterminado: csv

p. ej. csv
limitqueryintegeropcional

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

Desenlace del intento de entrega. success llegó. failed no llegó y ya no se reintenta. retrying falló pero queda algún intento. 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 con el historial consolidado de entregas de todos los endpoints (hasta 100,000 filas).Sin cuerpo
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
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0
429rate_limit_exceeded

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

Envelope
meta.request_id
f7a8b9c0d1e2
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 (emitido sólo en 429).
  • X-RateLimit-Remaining: integer — Solicitudes restantes en la ventana actual — siempre 0 en el momento del 429 (emitido sólo en 429).
  • X-RateLimit-Reset: integer — Unix epoch absoluto (segundos) en que se reinicia la ventana. Emitido sólo en 429, junto con Retry-After. Puede existir sobreescritura por endpoint (p. ej. `rate_limited_login`).