Skip to content
Notificator Project Docs

Quick Start

1. Pick your auth header

Section titled “1. Pick your auth header”

Use one of the following:

  • Authorization: Bearer wpnotif_... (recommended)
  • X-API-Key: wpnotif_...
  • X-WPNOTIF-Key: wpnotif_...

Use a key with type public_client (or internal_service).

wordpress_server keys are rejected by public-notify.

2. Send a test request

Section titled “2. Send a test request”
Terminal window
curl -X POST "https://api.notificator-project.com" \
  -H "Authorization: Bearer wpnotif_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Queue Backlog High",
    "body": "Order queue is above threshold.",
    "source": "erp_worker",
    "category": "task",
    "severity": "warning"
  }'

3. Validate response

Section titled “3. Validate response”

Successful response example:

{
  "ok": true,
  "kind": "external_notification",
  "stored": true,
  "pushSent": true,
  "mqttEnabled": true,
  "timestamp": "2026-03-29T12:00:00.000Z"
}

4. Open interactive docs

Section titled “4. Open interactive docs”
  • OpenAPI JSON: https://api.notificator-project.com?format=openapi

Notes

Section titled “Notes”
  • URL fields are optional for third-party notifications.
  • Public endpoint does not send emails.
  • If body is empty, app shows structured table only.
  • Requests with no meaningful payload fields return 400.
  • If your key has allowed_domains, ensure your request includes a matching Origin or Referer.