---
title: "Create Alert Subscription"
method: POST
path: "/alerts/subscriptions"
tags: ["Alerts"]
---

# Create Alert Subscription

`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`

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.

## Request body

- object
  - `name` string, required: Human-readable subscription name
  - `signal_types` string, required: Signal types to include (11 available)
  - `anomaly_categories` string: Anomaly categories to include (6 available)
  - `min_severity` string: Minimum severity: low, medium, high, critical (default: low)
  - `delivery_method` string, required: Delivery method: webhook or email
  - `delivery_frequency` string, required: Frequency: realtime, daily, or weekly
  - `webhook_url` string: Webhook endpoint URL (required if delivery_method is webhook)
  - `webhook_secret` string: Secret for HMAC-SHA256 signing of webhook payloads
  - `email_address` string: Email address (required if delivery_method is email)

## Response `200`

Create Alert Subscription

- Envelope: Standard API response envelope
  - `data` unknown
  - `meta` object
    - `api_version` string
    - `timestamp` string, date-time
    - `format` 'standard' | 'llm' | 'fdc3' | 'toon'
    - `endpoint` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/nzxplorer/apis/nzxplorer-api.md) · [All operations](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/revisions/f3b95341783a?raw)