Integrations › List integration deliveries

Integrations

List integration deliveries

GET/api/{ORG}/integrations/deliveriesPermalink

Newest first, 20 a page; ?status=sent|retrying|gaveup narrows them (gave up: this billing period's), ?folder=<code> to the integrations made for that folder. The next page's cursor is the x-next-cursor header: send it back as ?before=.

Permission
Analytics · view
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/NORTHWIND/integrations/deliveries" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
[  {    "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "to": "example",    "event": "link.click",    "linkId": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "link": "example",    "status": "QUEUED",    "attempt": 1,    "responseStatus": 1,    "lastError": "example",    "lastResponse": "example",    "durationMs": 1,    "nextAttemptOn": "2026-11-05T09:41:00Z",    "createdOn": "2026-11-05T09:41:00Z"  }]

Made-up values.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters

QueryPermalink

Query parameters
NameTypeRequiredDescriptionAllowed values
statusstringoptionalNarrows the answer: ?status=<value>, or ?status=eq:<value>.—
beforestringoptionalNarrows the answer: ?before=<value>, or ?before=eq:<value>.—
afterstringoptionalNarrows the answer: ?after=<value>, or ?after=eq:<value>.—
addstringoptionalNarrows the answer: ?add=<value>, or ?add=eq:<value>.—
eventsstringoptionalNarrows the answer: ?events=<value>, or ?events=eq:<value>.—
folderstringoptionalNarrows the answer: ?folder=<value>, or ?folder=eq:<value>.—
qstringoptionalA search term.—

AnswerPermalink

A list of Delivery, one page at a time: paging.

Answer fields
NameTypeDescriptionAllowed values
idstringThe delivery’s id (its X-Brevily-Delivery when sent).—
tostringWhere it goes: a webhook’s host, or “GA4 · <id>”.—
eventstringWhat it delivers: link.click, or another event the webhook chose.link.click, link.created, link.updated, link.expired, link.broken, event.reported
linkIdstringThe link it names; null when unknown.or null
linkstringThe short link it names (domain/back-half); null when unknown.or null
statusstringQUEUED (not tried yet), RETRYING (a try failed; it is tried again), SENT, DEAD (given up), or SKIPPED (past the plan’s deliveries: never sent, never charged).QUEUED, RETRYING, SENT, DEAD, SKIPPED
attemptintegerAttempts so far.—
responseStatusintegerThe receiver’s last HTTP status; null for none.or null
lastErrorstringWhy the last attempt failed; null when none did.or null
lastResponsestringThe first 500 characters of the receiver’s answer to the last attempt; null for none.or null
durationMsintegerHow long the last attempt took, in milliseconds.or null
nextAttemptOndate-timeA queued delivery’s next attempt; else null.or null
createdOndate-timeWhen it was queued.—

ErrorsPermalink

Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Analytics · view, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Rate limitsPermalink

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.