Nodd 開発者向けドキュメント

プログラムから iPhone へ通知と確認を送り、人の応答を受け取るための資料です。

流れ

  1. アプリでチャンネルを作り、送信キーを発行します
  2. プログラムが POST /v1/messages で通知を送ります。受け付けると 202 を返します
  3. チャンネルのメンバーの iPhone に届きます。本文は端末ごとに暗号化して預かり、端末が受け取ると消えます
  4. 応答が必要な種類は、状態の取得、callback、イベント API のいずれかで結果を受け取ります

読む順番

クイックスタート最初の通知と承認を送ります
APIエンドポイントと項目の上限です
CLInodd コマンドと終了コードです
GitHub Actionblipdrop/nodd-action@v1 の入力と出力です
MCP とフックAI エージェントから使う方法と、Claude Code で実行を止める方法です
受信 URLGrafana、Alertmanager、Datadog、Sentry、PagerDuty、Slack 形式の通知を受けます
応答の受け取りと署名callback、Nodd-Signature の検証、nod-respond-v1 と nod-respond-v2 です
エラーコードすべてのコードと対処です

キーの種類

送信キーnodd_live_s_ で始まります。通知の送信、状態の取得、取り下げなどに使います
読み取りキーnodd_live_r_ で始まります。GET /v1/actions/events だけに使えます
受信キーnodd_live_i_ で始まります。受信 URL の一部です
返信トークンrt_ で始まります。送信の応答で返り、その 1 通の状態だけを読めます

キーはすべてチャンネル専用です。宛先のチャンネルは本文で指定しません。

本文に秘密を入れないでください。本文は暗号化するまでサーバーの処理で読める状態です。metadata と応答に添えた文(却下の理由、input への回答)は端末ごとの暗号化の対象外です。詳しくはプライバシーポリシーをご覧ください。

API の仕様は blipdrop/nodd の spec/openapi.yaml にもあります。アプリの操作はマニュアルをご覧ください。