---
title: "Create Webhook"
method: POST
path: "/webhooks"
tags: ["Alerts"]
---

# Create Webhook

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

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.

## Request body

- object
  - `name` string, required: Human-readable webhook name
  - `url` string, required: Webhook endpoint URL (must be HTTPS)
  - `filters` string: Optional filters: { tickers: string[], sectors: string[], signal_types: string[] }

## Response `200`

Create Webhook

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