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.

GoalWhat you needContent boundary
Notify an existing public TopicA 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 HTTPSA private sending link generated on your phoneThe link contains a send-only key; service reads input before encrypted delivery
Let an Agent wait for an answerPhone app, CLI and protected Topic pairingAuthorized Source encrypts locally; answers require verification and one-time claim

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.

Terminal
ntfyx version --json
ntfyx connect

1. 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.

Terminal
ntfyx topics

2. 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.

Terminal
ntfyx send "Build 42 passed" --topic Work --json

3. 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.

Terminal
ntfyx ask "Continue this harmless demo?" --topic Work --allow-deny --wait 60s --expires 90s --json

Optional: 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.

●   TerminalWork   ·   9:41
ntfyx — zsh
❯ ntfyx connect
Demonstration QR code, not a live connection
Connect your iPhone

Open Ntfyx → Connect Topic

Waiting for your phone…✓   Work · connected
Single-use QR · expires in 5 minutes
✓ Work · iPhone connected
❯ ntfyx send "Build passed"
↗   Encrypted locally✓   Message accepted Work
❯
YOUR COMPUTER CLI / Agent
9:41
Ntfyx

Your work. Within reach.

Connect a Topic to receive your first message.

Connect Topic×

Point at the QR on your computer

✓Code recognizedTopic Work
Ntfyx+

Inbox

Work1 message0
✓You’re connected

Messages from your computer will appear here.

Terminal 9:41Build passed

Sent from your computer. Decrypted on your iPhone.

⌁ End-to-end encrypted

Tuesday, September 29

9:41Tap the notification to open ↑
YOUR IPHONE
01 / 04

Start on your computer

Run ntfyx connect. A one-time pairing code appears.

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 →