Skip to main content
GET
curl
Deliveries are the attempts Didit made to send a webhook to this destination. Automatic retries follow the retry policy and each appears as its own entry. To send one again after you fix your endpoint, call Resend Webhook Destination Delivery. For totals over a period, use Get Webhook Destination Analytics.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

destination_uuid
string<uuid>
required

UUID of the destination (the uuid returned by GET /v3/webhook/destinations/).

Query Parameters

limit
integer
default:50

Maximum number of deliveries per page. Defaults to 50. A value that is not a positive integer falls back to 50; a value above 1000000 returns 400.

Required range: 1 <= x <= 1000000
offset
integer
default:0

Number of deliveries to skip. Defaults to 0. Prefer following the next and previous URLs from the response.

Required range: 0 <= x <= 1000000
date_from
string<date>

First UTC day to include, as YYYY-MM-DD (inclusive). Omit to start from the oldest delivery available. dateFrom is accepted as an alias.

date_to
string<date>

Last UTC day to include, as YYYY-MM-DD (inclusive). Must not be earlier than date_from. dateTo is accepted as an alias.

Response

One page of deliveries, newest first.

count
integer
required

Matching deliveries, exact up to 100 and capped at 100 above that. Use next to know whether more pages exist.

Required range: x >= 0
next
string<uri> | null
required

Absolute URL of the next page, or null on the last page.

previous
string<uri> | null
required

Absolute URL of the previous page, or null on the first page.

results
object[]
required