Developers › API reference › Webhooks

GET /api/v1/webhooks/{id}/deliveries

The delivery log.

  • Scope webhooks:read
  • operationId webhooksDeliveries

The token needs the scope webhooks:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.

Request

GET /api/v1/webhooks/{id}/deliveries

Path parameters

NameDescriptionExample
idThe id of the webhook.2

Query parameters

NameRequiredDescription
limitnoPage size, 1 to 200 (default 50)
cursornoThe next_cursor of the previous page
sortno"-id" (newest first, default) or "id"
fieldsnoSparse fieldset: comma-separated field names
statusnopending, delivered, failed, dead

Headers

HeaderRequiredValue
AuthorizationyesBearer <token>: an OAuth access token (vat_…) or a personal access token (vpt_…). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/webhooks/2/deliveries" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/webhooks/2/deliveries",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/webhooks/2/deliveries", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: a page of Delivery. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields
FieldTypeDescription
datalist of DeliveryThe records of this page.
data[].idid (string)The record's id (a string of digits).
data[].webhook_idid (string)The webhook.
data[].event_typestringThe webhook event type.
data[].event_idstringThe id of the event delivered.
data[].statusstringpending, delivered, failed or dead.
data[].attemptsintegerHow many times the delivery was tried.
data[].last_statusinteger or nullHTTP status of the last attempt.
data[].last_errorstring or nullThe last error, if any.
data[].next_attempt_atdate-time or nullWhen the next retry is due.
data[].created_atdate-time or nullWhen it was created.
data[].delivered_atdate-time or nullWhen the receiver answered 2xx.
data[].payloadanyThe event as delivered (signed with the webhook secret).
next_cursorstring or nullPass as ?cursor= for the next page; null on the last page.
has_morebooleanTrue when another page follows.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": "1042",
            "webhook_id": "2",
            "event_type": "fill.created",
            "event_id": "evt_000188",
            "status": "delivered",
            "attempts": 1,
            "last_status": 200,
            "last_error": null,
            "next_attempt_at": null,
            "created_at": "2026-10-27T14:30:00Z",
            "delivered_at": null,
            "payload": []
        }
    ],
    "next_cursor": "eyJpZCI6NTI5OX0",
    "has_more": true
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

StatusWhenProblem codes
200Success
400The request is malformedinvalid_request
401No token, or it is invalid or expiredinvalid_token
403The token lacks the scope, or the person or service account behind it lacks the privilege or account permissioninsufficient_scope forbidden ip_not_allowed
404Not found, or not visible to you (the API never confirms what you may not see)not_found
429Rate limited: wait for Retry-After secondsrate_limited
{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/webhooks/2/deliveries"
}

On the screens

The same thing in the app is explained in: