Alerts

Zapier: Subscribe REST Hook

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.

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

Request body

target_urlstring required

Zapier webhook receiver URL

event_typestring required

Event type: announcement, insider_trade, grs_change, dividend, capital_raise, director_change, earnings, composite_signal

tickersstring

Ticker filter (empty = all)

sectorsstring

Sector filter (empty = all)

Response

Zapier: Subscribe REST Hook

dataunknown

Example response

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

Changes

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