API preview · v1

NotiFire API

Send notifications, target channels, and inspect delivery through one predictable interface.

Base URL: api.notifire.example/v1JSON over HTTPS

Authentication

Bearer API keys

Include a scoped workspace key in the Authorization header. Demo keys shown here are intentionally non-functional.

Authorization: Bearer nf_demo_••••••

POST /notifications

Send a notification

Provide the event, human-readable title, destination channels, and optional structured data.

curl -X POST \
  https://api.notifire.example/v1/notifications \
  -H "Authorization: Bearer nf_demo_••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "deployment.ready",
    "title": "Production deploy complete",
    "channels": ["slack", "whatsapp"],
    "data": {
      "version": "v2.8.0"
    }
  }'

Example response

{
  "id": "ntf_demo_01J9YQ4K8B",
  "status": "queued",
  "channels": [
    { "type": "slack", "status": "queued" },
    { "type": "whatsapp", "status": "queued" }
  ],
  "created_at": "2026-07-27T09:42:18Z"
}

Delivery webhooks

Subscribe to delivery updates and reconcile notification state in your own application.

notification.delivered

notification.failed

notification.retried

Errors

400invalid_requestThe request body is missing a required field.

401unauthorizedThe API key is missing, invalid, or expired.

429rate_limitedThe workspace has exceeded its current request rate.

This reference is illustrative. Final endpoint shapes, limits, and guarantees will be published with the production API.