Skip to main content
POST
Create webhook subscription
The URL must use HTTPS, contain no embedded credentials, and resolve only to public IP addresses. Each account can create up to 10 subscriptions with up to 100 ticker symbols per subscription. The signing secret appears only in the creation response.
Subscription CRUD is in the core rollout. Core does not yet deliver webhook events, so creating a subscription does not start notifications.

Authorizations

X-API-Key
string
header
required

VecTrade VQ API key (vq_...)

Body

application/json
url
string<uri>
required

HTTPS endpoint resolving only to public IP addresses

Maximum string length: 2048
events
enum<string>[]
required
Available options:
quote.update,
price.alert,
news.published,
screener.match
description
string
Maximum string length: 255
symbols
string[]

Filter events to specific symbols

Maximum array length: 100

Response

Webhook created

id
string
url
string<uri>
description
string | null
events
string[]
symbols
string[]
secret
string

Signing secret (only returned on creation)

createdAt
string<date-time>
active
boolean