GET `/api/v1/webhooks`

Webhooks.

Scope webhooks:read
operationId webhooksList

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.

Request

GET /api/v1/webhooks

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <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" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/webhooks",
    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", {
  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: WebhookList. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of Webhook	The records of this page or list.
`data[].id`	id (string)	The record's id (a string of digits).
`data[].url`	string	Your HTTPS endpoint.
`data[].events`	list of string	Event types to send (see the webhook guide).
`data[].status`	string	"active" or "paused".
`data[].description`	string	A note for you.
`data[].failing_deliveries`	integer	Deliveries currently failing.
`data[].created_at`	date-time or null	When it was created.
`data[].last_delivery_at`	date-time or null	When the last delivery was tried.
`data[].secret`	string	The new signing secret (only when rotated).
`data[].secret_note`	string	A reminder that the secret is shown once.
`event_types`	list of ScopeLikeType	Every event type you can subscribe to.
`event_types[].type`	string	The type.
`event_types[].description`	string	A description in plain words.
`signing`	string	How deliveries are signed.

Example response

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

{
    "data": [
        {
            "id": "1042",
            "url": "https://hooks.example.com/vestoris",
            "events": [
                "fill.created",
                "violation.created"
            ],
            "status": "active",
            "description": "Fills to the risk system",
            "failing_deliveries": 0,
            "created_at": "2026-10-27T14:30:00Z",
            "last_delivery_at": null,
            "secret": "text",
            "secret_note": "Shown once. Store it now."
        }
    ],
    "event_types": [
        {
            "type": "text",
            "description": ""
        }
    ],
    "signing": "HMAC-SHA256 of \"<timestamp>.<body>\" in the Vestoris-Signature header"
}

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.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
429	Rate limited: wait for Retry-After seconds	`rate_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"
}

On the screens

The same thing in the app is explained in:

API clients and webhooks