---
title: "Test Webhook Delivery"
method: POST
path: "/alerts/test"
tags: ["Alerts"]
---

# Test Webhook Delivery

`POST /alerts/test`

## Request

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

Send a test alert payload to a subscription\

## Request body

- object
  - `subscription_id` number, required: ID of the subscription to test

## Response `200`

Test Webhook Delivery

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