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
curl "https://console.brevily.com/api/NORTHWIND/integrations/deliveries" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET"const res = await fetch("https://console.brevily.com/api/NORTHWIND/integrations/deliveries", { headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, },});const answer = await res.json();Example answer
[ { "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" }]{ "code": "VALIDATION_FAILED", "message": "Check the form. status: Not a value this field takes.", "details": { "fields": { "status": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
QueryPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
status | string | optional | Narrows the answer: ?status=<value>, or ?status=eq:<value>. | — |
before | string | optional | Narrows the answer: ?before=<value>, or ?before=eq:<value>. | — |
after | string | optional | Narrows the answer: ?after=<value>, or ?after=eq:<value>. | — |
add | string | optional | Narrows the answer: ?add=<value>, or ?add=eq:<value>. | — |
events | string | optional | Narrows the answer: ?events=<value>, or ?events=eq:<value>. | — |
folder | string | optional | Narrows the answer: ?folder=<value>, or ?folder=eq:<value>. | — |
q | string | optional | A search term. | — |
AnswerPermalink
A list of Delivery, one page at a time: paging.
| Name | Type | Description | Allowed values |
|---|---|---|---|
id | string | The delivery’s id (its X-Brevily-Delivery when sent). | — |
to | string | Where it goes: a webhook’s host, or “GA4 · <id>”. | — |
event | string | What it delivers: link.click, or another event the webhook chose. | link.click, link.created, link.updated, link.expired, link.broken, event.reported |
linkId | string | The link it names; null when unknown. | or null |
link | string | The short link it names (domain/back-half); null when unknown. | or null |
status | string | QUEUED (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 |
attempt | integer | Attempts so far. | — |
responseStatus | integer | The receiver’s last HTTP status; null for none. | or null |
lastError | string | Why the last attempt failed; null when none did. | or null |
lastResponse | string | The first 500 characters of the receiver’s answer to the last attempt; null for none. | or null |
durationMs | integer | How long the last attempt took, in milliseconds. | or null |
nextAttemptOn | date-time | A queued delivery’s next attempt; else null. | or null |
createdOn | date-time | When it was queued. | — |
ErrorsPermalink
| 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.
Type a call, a field or a guide.