Documentation
Quickstart: your first notification or verified answer
Choose an existing public Topic, private HTTPS push or protected Topic. Check the first message on your phone, then try a verified answer.
Updated
Choose your first task
#For a notification, start with the route that fits your sender. Complete one message receipt on your own phone; use a protected Topic when an Agent needs your answer. The connection animation illustrates protected Topic pairing.
| Goal | What you need | Content boundary |
|---|---|---|
| Notify an existing public Topic | A real shared link or ID; browser or CLI 0.6.0+ | No pairing; service and link holders can read, link holders can send; no answers or Call |
| Send from a service over HTTPS | A private sending link generated on your phone | The link contains a send-only key; service reads input before encrypted delivery |
| Let an Agent wait for an answer | Phone app, CLI and protected Topic pairing | Authorized Source encrypts locally; answers require verification and one-time claim |
Notification path: public Topic or private HTTPS link
#With an existing public Topic, follow the public guide to check its name, send a non-sensitive message and confirm phone receipt. The phone must own or have confirmed following the Topic; visiting its webpage is not a subscription. For a non-public notification, use the complete private link from phone HTTPS Push and follow its hello walkthrough.
The service can read HTTPS input; use the protected CLI route below when content must be encrypted at the sender.
Answer path: prepare the phone and CLI
#Install Ntfyx on iPhone or Android and the CLI on Windows, macOS or Linux. Android background push requires Google Play services. Follow the installer for your OS, then check ntfyx version. The commands below work once the CLI is installed on any of these desktop platforms; use the PowerShell installation instructions on Windows.
No Ntfyx account is required, but your phone must authorize this sender.
ntfyx version --json
ntfyx connect1. Connect a protected Topic
#Keep ntfyx connect running, choose the private Topic connection option on the phone and scan the fresh QR on your trusted computer. Confirm the Source and choose a protected Topic; when creating through pairing, follow the connection flow offered by your installed version. A public link is not a pairing code.
Once connected, run topics and note the local CLI alias. Replace Work below if your listed alias differs.
ntfyx topics2. Receive an encrypted notification
#Send this non-sensitive test and open its Topic in the phone Inbox. Confirm that Build 42 passed appears. CLI success means acceptance by the service; phone foreground synchronization, background push and a system banner are separate observations. Foreground Inbox synchronization can work even when system notification permission is declined.
ntfyx send "Build 42 passed" --topic Work --json3. Answer a harmless question
#Keep the terminal waiting, open the original question on the phone and choose Allow or Deny. This command demonstrates a question; it is not connected to a deployment, payment or external action. Synchronous ask verifies the answer at the original Source and acquires its one-time claim before returning an allowed result.
Deny is a complete answer; a timeout is not consent and a late answer cannot restart an ended job.
ntfyx ask "Continue this harmless demo?" --topic Work --allow-deny --wait 60s --expires 90s --jsonOptional: receive new messages in a browser
#Open the Web Inbox and authorize its fresh QR with the primary phone. The browser receives independent receiver keys and reads new messages addressed to it after authorization; it does not inherit old phone history. Keep the page open for updates. A public Topic webpage does not need this pairing step, and its content is public.
FROM YOUR DESK TO YOUR POCKET
Watch the connection happen.
Open Ntfyx → Connect Topic
Waiting for your phone…✓ Work · connectedYour work. Within reach.
Connect a Topic to receive your first message.
Point at the QR on your computer
Inbox
Messages from your computer will appear here.
Tuesday, September 29
9:41Tap the notification to open ↑Start on your computer
Run ntfyx connect. A one-time pairing code appears.
Scan. Name your Topic.
Scan with Ntfyx, then create Work or choose an existing Topic.
Send from your terminal
One command. Your CLI or agent encrypts the message before sending.
There it is. On your phone.
Your iPhone decrypts the notification. Tap it to read in your Topic.
Protected Topic illustration. Public Topic and HTTPS sending do not use this pairing flow. The QR and message are demonstration data. See the full workflow →