HTTP API

Publish and subscribe over HTTP.

Point curl or the SwiftNotify desk at this server. Examples use the topic name alerts. Base URL: https://swiftnotify.me

Publish

  • PUT or POST /{topic} — plain text body
  • POST / — JSON body with topic
  • Headers: Title, Priority, Tags, Click
  • Auth: Authorization: Bearer …, X-Access-Token, or ?auth=
curl -d "Invoice 1042 is overdue" \
  -H "Title: Overdue" -H "Priority: urgent" -H "Tags: invoice,warning" \
  https://swiftnotify.me/alerts

Subscribe

  • GET /{topic}/json — NDJSON stream (poll=1, since=)
  • GET /{topic}/sse — EventSource
  • GET /{topic}/raw — message lines
  • GET /{topic}/ws — WebSocket
  • GET /{topic}/qr — subscribe QR that opens the SwiftNotify desk
  • GET /add/{client} — invite or add link; opens the desk and adds the topic
  • GET /add/{client}/qr — add QR
  • GET /clients — published client catalog
  • GET /org — school or business: audiences, invites, Google or Microsoft connect
  • GET /v1/health
curl -s "https://swiftnotify.me/alerts/json?poll=1"

Organizations and calendars

Create audiences such as Parents or Year 7, then share the invite. Staff can send from the organization page. Connect Google or Microsoft so new calendar events and matching folder mail notify those audiences. SwiftNotify only reads the folder or label you name.