GEThttps://api.veriko.mx/v1/webhooks/{id}/deliveries/export

Export endpoint deliveries as CSV or XLSX

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

Downloads up to 100,000 records of a specific webhook endpoint's delivery history.
Download formats: csv or xlsx.

Parameters
ParameterInTypeRequiredDescription
id*pathstring (uuid)required

Unique identifier of the webhook endpoint (UUID v4).

e.g. f47ac10b-58cc-4372-a567-0e02b2c3d479
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
Request
curl -X GET 'https://api.veriko.mx/v1/webhooks/{id}/deliveries/export' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response status codesGET /v1/webhooks/{id}/deliveries/export
StatusClassDescriptionBody
2002xxCSV or XLSX file with the delivery history for this endpoint (up to 100,000 rows).Body without schema
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
4044xxThe resource does not exist or is not visible to the clientError
4294xxRate limit exceededErrorResponse
Errors from GET /v1/webhooks/{id}/deliveries/export
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d
429rate_limit_exceeded

Rate limit exceeded. Try again in 45 seconds.

Envelope
meta.request_id
f7a8b9c0d1e22e1d0c9b8a7f
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. It is emitted on every 429 and, on the authenticated API, also on successful responses, where it is the per-key cap of the account plan.
  • X-RateLimit-Remaining: integer — Requests remaining in the current window. Always 0 at the moment of the 429; on a successful response of the authenticated API it is what is left of the per-key cap.
  • X-RateLimit-Reset: integer — Absolute Unix epoch (seconds) when the window resets. Emitted on every 429, alongside Retry-After, and on successful responses of the authenticated API. Per-endpoint overrides exist (e.g. `rate_limited_login`).