Nodd developer docs

How to send notifications and questions from programs to an iPhone and get a person's response back.

How it works

  1. Create a channel in the app and issue a send key
  2. Your program sends a message with POST /v1/messages. The API answers 202 when it accepts it
  3. It reaches the iPhones of channel members. Bodies are stored encrypted to each device and deleted once received
  4. For messages that need a response, read the result by polling, by callback, or from the events API

Where to go next

QuickstartSend your first notification and approval
APIEndpoints and field limits
CLIThe nodd command and exit codes
GitHub ActionInputs and outputs of blipdrop/nodd-action@v1
MCP and hooksUsing Nodd from AI agents, and stopping execution in Claude Code
Inbound URLsReceive Grafana, Alertmanager, Datadog, Sentry, PagerDuty, and Slack format webhooks
Callbacks and signaturesCallbacks, verifying Nodd-Signature, and nod-respond-v1 and nod-respond-v2
Error codesEvery code and what to do

Key types

Send keyStarts with nodd_live_s_. Sends messages, reads their state, cancels, and so on
Read keyStarts with nodd_live_r_. Works only for GET /v1/actions/events
Inbound keyStarts with nodd_live_i_. Part of an inbound URL
Reply tokenStarts with rt_. Returned when you send, and reads the state of that one message only

All keys belong to one channel. You do not name a channel in the request body.

Do not put secrets in messages. Our servers can read a body until it is encrypted. metadata and text added to a response (a rejection reason or an input answer) are not encrypted to devices. See the Privacy Policy.

The API specification is also at spec/openapi.yaml in blipdrop/nodd. For using the app, see the Manual.