Getting started

From zero to a card on your desktop in three steps: install the app, create a token, send a message.

1. Install the desktop app

Notify runs as a resident tray app (Tauri 2 — a few MB on disk, ~30 MB of memory). Download the installer for your platform from the latest release. Builds are unsigned for now: on macOS right-click → Open the first time; on Windows pick More info → Run anyway. (Building from source also works: pnpm --filter @saasflare-dev/tauri app:build.)

Launch the app and press Sign in with browser — it opens this site, reuses your browser session (or lets you create an account), and hands the login back to the app automatically. The app then keeps a WebSocket to your personal hub and stays in the tray; closing the window keeps it running.

2. Create an API token

Open the console and create a token. Tokens look like ntfy_…, are shown once, stored hashed, and can be revoked individually — one per sender (CI, cron, monitoring) is a good habit.

3. Send your first message

curl -X POST https://<your-server>/v1/send \
  -H 'Authorization: Bearer ntfy_...' \
  -H 'Content-Type: application/json' \
  -d '{"template":"text","data":{"title":"Hello from my pipeline 👋"}}'

A toast pops on your desktop within the second. If the app is offline, the message waits in your queue and is replayed on reconnect. Continue with Sending for the full payload reference.