Alerts

Create Alert Subscription

Create a new alert subscription. Configure which signal types (11 types: insider_trade, capital_raise, dividend, earnings, agm_result, director_change, grs_change, technical_signal, credit_rating, audit_change, takeover) and anomaly categories (insider, governance, financial, market, agm, corporate) to monitor. Filter by tickers and/or sectors. Choose webhook or email delivery with realtime, daily, or weekly frequency. Webhook payloads are signed with HMAC-SHA256. Enterprise tier required.

post/alerts/subscriptions

Request

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

Request body

namestring required

Human-readable subscription name

signal_typesstring required

Signal types to include (11 available)

anomaly_categoriesstring

Anomaly categories to include (6 available)

min_severitystring

Minimum severity: low, medium, high, critical (default: low)

delivery_methodstring required

Delivery method: webhook or email

delivery_frequencystring required

Frequency: realtime, daily, or weekly

webhook_urlstring

Webhook endpoint URL (required if delivery_method is webhook)

webhook_secretstring

Secret for HMAC-SHA256 signing of webhook payloads

email_addressstring

Email address (required if delivery_method is email)

Response

Create Alert Subscription

dataunknown

Example response

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

Changes

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