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

Export all deliveries as CSV or XLSX

Audience
public
Auth
API key
Permission
webhooks:read
How-to guide →

Downloads the delivery history of every endpoint on the account as a file, under the same filters as the list: endpoint, status, and event type. The format is chosen with ?formatcsv by default, xlsx as the alternative — and the cap is 100,000 rows, which ?limit can lower. Exporting before deleting an endpoint is worth doing: DELETE /v1/webhooks/{id} takes its history with it and there is no way to recover it.

Parameters
ParameterInTypeRequiredDescription
endpoint_idquerystring (uuid)optional

Filter by a specific endpoint UUID (same as /webhooks/{id}/deliveries).

e.g. 7c9e6679-7425-40de-944b-e07fc1f90ae7
event_typequerystringoptional

Type of event that produced the delivery. From a validation's lifecycle: validation.completed when it ends well, validation.failed when it ends badly, and validation.error when it breaks on our side. And from its automatic retries: validation.retry.scheduled when one is scheduled, validation.retry.resolved when a retry ends up finding the receipt, and validation.retry.exhausted when they run out without success. From the subscription: billing.payment_succeeded and billing.payment_failed for each charge, billing.invoice_upcoming before the next invoice, billing.trial_will_end before the trial runs out, and billing.subscription_canceled when it is cancelled.

e.g. validation.completed
formatquerystringoptional

Output format. csv by default; xlsx produces a spreadsheet. Any other value is served as csv.

Default: csv

e.g. csv
limitqueryintegeroptional

Trims the number of rows in the file. It only lowers the cap: a value above 100,000, or below 1, leaves the default cap in place.

e.g. 500
statusquerystringoptional

Outcome of the delivery attempt. success arrived. failed did not arrive and will not be retried. retrying failed but has attempts left. pending has not been attempted yet.

e.g. failed
Request
curl -X GET 'https://api.veriko.mx/v1/webhooks/deliveries/export' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response status codesGET /v1/webhooks/deliveries/export
StatusClassDescriptionBody
2002xxCSV file with the consolidated delivery history across all endpoints (up to 100,000 rows).No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
4294xxRate limit exceededErrorResponse
Errors from GET /v1/webhooks/deliveries/export
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
429rate_limit_exceeded

Rate limit exceeded. Try again in 45 seconds.

Envelope
meta.request_id
f7a8b9c0d1e2
Response headers
  • Retry-After: integer — Seconds to wait before retrying. Matches the endpoint's rate-limit window (typically 60s for list endpoints, 1-5s for in-flight idempotent operations).
  • X-RateLimit-Limit: integer — Configured request cap for this bucket (emitted only on 429).
  • X-RateLimit-Remaining: integer — Requests remaining in the current window — always 0 at the moment of the 429 (emitted only on 429).
  • X-RateLimit-Reset: integer — Absolute Unix epoch (seconds) when the window resets. Emitted only on 429, alongside Retry-After. Per-endpoint overrides exist (e.g. `rate_limited_login`).