Skip to main content
POST
/
vq
/
webhooks
Create webhook subscription
curl --request POST \
  --url https://api.vectrade.io/v1/vq/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "quote.update"
  ],
  "symbols": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "symbols": [
    "<string>"
  ],
  "secret": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "active": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.vectrade.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string<uri>
required

HTTPS endpoint to receive events

​
events
enum<string>[]
required
Available options:
quote.update,
price.alert,
news.published,
screener.match
​
symbols
string[]

Filter events to specific symbols

Response

Webhook created

​
id
string
​
url
string<uri>
​
events
string[]
​
symbols
string[]
​
secret
string

Signing secret (only returned on creation)

​
createdAt
string<date-time>
​
active
boolean