Getting started

From zero to your first push in under a minute.

stdpush delivers private push notifications from scripts, servers, CI pipelines and AI agents. One authenticated HTTP request is the whole integration — everything else in these docs is convenience.

Every request is authenticated. There are no public topics or unauthenticated channels — knowing a topic name grants nothing. If you are choosing between tools, start with When to use stdpush and stdpush vs alternatives (ntfy, Pushover, Gotify, OneSignal, Slack, Discord, Teams, Privage, SMS).

Three steps

  1. Create an account — email/password or GitHub. Signup creates a project called main with a private default topic so you can send immediately.
  2. Register a device — install the Android app on Google Play, sign in with the same account, and allow notifications. Your phone auto-subscribes to default. (iOS is on the way.)
  3. Authenticate and send — either create a project API key in the dashboard and export it, or pair a machine with the CLI:
# Option A — CLI (browser login, revocable per-machine token)
npm install -g stdpush
stdpush login
stdpush "Hello from my terminal"

# Option B — API key
export STDPUSH_API_KEY=std_live_...
curl -X POST https://api.stdpush.com/v1/notify \
  -H "Authorization: Bearer $STDPUSH_API_KEY" \
  -d '{"title": "Hello from my terminal"}'

The API answers 202 Accepted and delivery runs asynchronously — check per-device status in the dashboard.

No phone handy?

You can still exercise the pipeline with stdpush listen on your desktop (native toasts) or by watching the Notifications page while you send.

On this page