POST `/api/v1/webhooks/{id}/ping`

Send a test event.

Scope webhooks:write
Idempotency-Key
operationId webhooksPing

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

Idempotency-Key. Send a unique Idempotency-Key (up to 255 characters, e.g. a UUID) with every POST. Retrying with the same key and body replays the first answer for 24 hours, so a timeout never creates a second order; the same key with a different body is refused (idempotency_key_reused).

Request

POST /api/v1/webhooks/{id}/ping

Path parameters

Name	Description	Example
`id`	The id of the webhook.	`2`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`Idempotency-Key`	yes	A unique string up to 255 characters (a UUID). Idempotency

Examples

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

curl

curl -X POST "https://vestoris.com/api/v1/webhooks/2/ping" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11'

Python (requests)

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/webhooks/2/ping",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    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/ping", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

202 Accepted, application/json: Delivery. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`webhook_id`	id (string)	The webhook.
`event_type`	string	The webhook event type.
`event_id`	string	The id of the event delivered.
`status`	string	pending, delivered, failed or dead.
`attempts`	integer	How many times the delivery was tried.
`last_status`	integer or null	HTTP status of the last attempt.
`last_error`	string or null	The last error, if any.
`next_attempt_at`	date-time or null	When the next retry is due.
`created_at`	date-time or null	When it was created.
`delivered_at`	date-time or null	When the receiver answered 2xx.
`payload`	any	The event as delivered (signed with the webhook secret).

Example response

HTTP/1.1 202 Accepted
Content-Type: application/json

{
    "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": []
}

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
202	Accepted: a job (or the file) is being processed
200 / 201	The same Idempotency-Key again: the first answer is replayed (24 hours)
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`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict` `idempotency_in_progress`
422	Validation failed (the detail says which field), or blocked	`validation_failed` `idempotency_key_reused`
428	A required header is missing	`idempotency_key_required`
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/2/ping"
}

On the screens

The same thing in the app is explained in:

API clients and webhooks