---
title: "Zapier: Subscribe REST Hook"
method: POST
path: "/zapier/hooks"
tags: ["Alerts"]
---

# Zapier: Subscribe REST Hook

`POST /zapier/hooks`

## Request

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

Register a REST Hook for real-time event push. Zapier calls this when a Zap is turned on. Events are pushed to target_url during the cron dispatch cycle. Auto-deactivates on 410 Gone.

## Request body

- object
  - `target_url` string, required: Zapier webhook receiver URL
  - `event_type` string, required: Event type: announcement, insider_trade, grs_change, dividend, capital_raise, director_change, earnings, composite_signal
  - `tickers` string: Ticker filter (empty = all)
  - `sectors` string: Sector filter (empty = all)

## Response `200`

Zapier: Subscribe REST Hook

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