Q4API Docs
Q4 APISign inGet API key
DocumentationAPI Reference
Overview
API reference
Companies
GETList companiesGETRetrieve a companyGETList sectors
Market data
GETRetrieve a quoteGETList quotesGETRetrieve price historyGETRetrieve index historyGETRetrieve market summaryGETList market moversGETList sector performanceGETList tradesGETRetrieve order book depth
WebSocket
WSQuotes streamWSTrades streamWSDepth stream
Fundamentals
GETRetrieve standardised statementsGETRetrieve as-reported statementsGETList figuresGETRetrieve ratiosGETCompare companiesGETList dividendsGETList corporate actionsGETList stock eventsGETSearch notes
Documents
GETList documentsGETRetrieve a documentGETList document pagesGETRetrieve document textGETRetrieve document summaryGETList notesGETRetrieve a noteGETList sectionsGETRetrieve a sectionGETSearch board report sections
Earnings calls
GETList earnings callsGETRetrieve an earnings callGETRetrieve a transcriptGETRetrieve call audio
Announcements
GETList announcementsGETRetrieve an announcement
Economic data
GETList seriesGETList observations
Webhooks & alerts
POSTCreate a webhookGETList webhooksDELDelete a webhookPOSTCreate an alert ruleGETList alert rulesDELDelete an alert rule
Account
GETRetrieve usage
Webhooks & alerts

Create a webhook

POSThttps://api.q4.sa/v1/webhooks
Registers an HTTPS endpoint to receive events.
Pro+

The response includes the signing_secret once. Store it: you need it to verify signatures.

Authorization

x-api-keyheaderrequired
Your API key. See Authentication.

Body

urlstringrequired
HTTPS URL that accepts POST requests.
eventsstring (comma-separated)required
Event types to send. See Events.
symbolsstring (comma-separated)
Only events for these symbols. Omit for all.
descriptionstring
A note for yourself.

Response

dataobject
The result.
idstring
Unique ID.
urlstring
Endpoint URL.
eventsstring[]
Event types.
symbolsstring[]
Symbols.
statusstring
Current status.
signing_secretstring
created_atdatetime
When this record was created.

Errors

400, 401, 403, 404, 429. Every error has the same shape: see Errors.
← Previous
List observations
Next →
List webhooks
Request
curl -X POST "https://api.q4.sa/v1/webhooks" \
  -H "x-api-key: $Q4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/q4/webhooks","events":["announcement.created","document.created"],"symbols":["2222","1120"]}'
Response
{
  "data": {
    "id": "whk_5Ty7Ua",
    "url": "https://example.com/q4/webhooks",
    "events": [
      "announcement.created",
      "document.created"
    ],
    "symbols": [
      "2222",
      "1120"
    ],
    "status": "active",
    "signing_secret": "whsec_Zp4c…",
    "created_at": "2026-11-04T09:00:00Z"
  }
}