List deliveries

GET/v1/events/{id}/deliveries

Returns every delivery attempt for an event, to every endpoint, newest first.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Path parameters#

idstring (uuid)Required

Query parameters#

limitinteger
1 to 100. Default 25.
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page.

Response fields#

Returns 200 with list of Delivery

dataarray of Delivery
Show attributesDelivery
- idstring (uuid)
  The delivery attempt's id.
- event_idstring (uuid)
  The event that was sent.
- webhook_endpoint_idstring (uuid)
  Where it was sent.
- attemptinteger
  1 for the first attempt, then counting up through the retries.
  Min 1
- statusstring
  pending, succeeded or failed.
  One of pending, succeeded, failed
- status_codeintegerNullable
  HTTP status your server returned. Null if there was no response.
- response_msintegerNullable
  How long your server took to respond, in milliseconds.
- errorstringNullable
  Why it failed when there was no HTTP status, for example timeout, connection_refused, tls_error or dns_error.
- attempted_atstring (date-time)Nullable
  When the attempt was made.
- next_retry_atstring (date-time)Nullable
  When the next retry is scheduled. Null after a success or when retries have run out.
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/events/{id}/deliveries

1
2curl https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47/deliveries \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47/deliveries", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    "https://api.unplugdining.com/v1/events/7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47/deliveries",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30{
  "data": [
    {
      "id": "5e2a9f7c-4d1b-4e38-b6a0-2c8f1d7e3b95",
      "event_id": "7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47",
      "webhook_endpoint_id": "1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
      "attempt": 2,
      "status": "succeeded",
      "status_code": 200,
      "response_ms": 184,
      "error": null,
      "attempted_at": "2026-11-05T14:08:57Z",
      "next_retry_at": null
    },
    {
      "id": "9b4d1e6a-7c3f-4a52-8e0d-1f5b9c2a6d47",
      "event_id": "7f3a9c2e-4b8d-4e16-a0c5-1d6b8e2f9a47",
      "webhook_endpoint_id": "1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
      "attempt": 1,
      "status": "failed",
      "status_code": null,
      "response_ms": null,
      "error": "timeout",
      "attempted_at": "2026-11-05T14:08:52Z",
      "next_retry_at": "2026-11-05T14:08:57Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error descriptions#

404Not found

not_found

No such event, or it's older than 30 days.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No such event, or it's older than 30 days."
}