Alerts

Create Webhook

Create a new webhook subscription with name, URL, and optional filters for tickers, sectors, and signal types. Payloads are signed with HMAC-SHA256. Supports 12 market event types (insider_trade, capital_raise, dividend, earnings, agm_result, director_change, grs_change, technical_signal, credit_rating, audit_change, takeover, board_event) and 6 board event types. Enterprise tier required.

post/webhooks

Request

  • Base URL: https://nzxplorer.co.nz/api/v1
  • URL: https://nzxplorer.co.nz/api/v1/webhooks
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Request body

namestring required

Human-readable webhook name

urlstring required

Webhook endpoint URL (must be HTTPS)

filtersstring

Optional filters: { tickers: string[], sectors: string[], signal_types: string[] }

Response

Create Webhook

dataunknown

Example response

{
  "meta": {
    "api_version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.