How to send

Your code is in the app. Swap it for YOUR-CODE-HERE below.

The one-liner

curl api.nudgenudge.app/YOUR-CODE-HERE -d "Backup finished"

Who it's from, and their logo

curl api.nudgenudge.app/YOUR-CODE-HERE \
  -H "From: GitHub" -H "Icon: github.com" \
  -d "PR #42 merged"

Icon is a domain (we find its logo) or an image URL. Send it once: the app remembers each source's logo.

Every field

FieldWhat it does
bodyThe message. Required. Plain -d "text" is the body.
fromThe source's name. Nudges are grouped by it.
iconA domain (stripe.com) or an https:// image URL.
titleA bold line above the message.
urlOpened when you tap the nudge.
levelpassive (no sound), normal, time-sensitive or critical (both break through Focus, Pro).

Use them as headers, form fields, query parameters or JSON, whichever your tool makes easiest:

curl api.nudgenudge.app/YOUR-CODE-HERE --json '{"from":"Stripe","icon":"stripe.com","body":"£49 payment"}'
curl "api.nudgenudge.app/YOUR-CODE-HERE?from=Pi&m=Garage+door+open"
curl api.nudgenudge.app/YOUR-CODE-HERE -d from=Cron -d body="Job ran"

Sealed nudges with nn

nn encrypts every nudge before it leaves your machine, to a key that only your phone holds.

brew install nudgenudge/tap/nn          # or: curl -fsSL nudgenudge.app/install | sh
nn setup YOUR-CODE-HERE                  # once: saves your code, pins your phone's key
nn "Deploy done"
nn -f GitHub -i github.com -t "PR merged" "nudgenudge#42"
make && nn "Built" || nn -l time-sensitive "Build failed"

In CI, set NN_CODE instead of running setup. nn shows your phone's key fingerprint on setup: check it matches Settings › Sealed nudges.

What you get back

{"ok":true,"locked":false,"left":4}
200Delivered to Apple. locked: true means it's past today's free 5: it arrived, locked until Pro.
400Something's missing; the message says what.
404No phone has that code. Check it in the app.
410That code's phone has gone (app removed or code renewed).
413Too big for a push (about 3 KB of text).
429Slow down, or 1,000 today already.

Keep your code safe

Anyone with your code can nudge you, so treat it like a password. If it leaks, tap Get a new code in Settings: the old one stops at once.