Hachiko ローカルAPI仕様書

JSON を送信します。title と body は必須です。

Invoke-RestMethod -Method Post -Uri http://127.0.0.1:8080/notify -ContentType application/json -Body '{"title":"Build finished","body":"The first Hachiko notification arrived.","channel":"discord"}'

Invoke-RestMethod -Method Post -Uri http://127.0.0.1:8080/notify -ContentType application/json -Body '{"title":"Nightly build","body":"Send to every enabled target"}'

{
  "id": "2f8f6cf4-1f9e-49da-bf1a-0b61bc53e7df",
  "accepted": true,
  "notification_ids": [
    "2f8f6cf4-1f9e-49da-bf1a-0b61bc53e7df"
  ],
  "accepted_count": 1
}

POST /notify のレスポンスは「受付できたか」を返します。 channel を省略した場合は、notification_ids と accepted_count が複数件になることがあります。 実際の送信失敗や再試行は、あとから /history と /history/summary で確認してください。

Service が応答しているかだけを軽く確認したいときに使います。

{
  "status": "ok",
  "queued_count": 0
}

現在の設定も含めた状態を取得します。Web UI の表示元の 1 つです。

/status と /history/summary をまとめた画面向け API です。

channel は必須です。 mode に connection を指定するとその場で接続確認、 queue を指定すると通常の通知キューへ積んで確認します。

Invoke-RestMethod -Method Post -Uri http://127.0.0.1:8080/notify/test -ContentType application/json -Body '{"channel":"discord","mode":"connection"}'

{
  "ok": true,
  "mode": "connection",
  "queued": false,
  "notification_id": null,
  "message": "接続テストに成功しました",
  "error_code": null,
  "error_message": null
}

通知履歴の一覧です。各レコードには受付時刻、処理時刻、失敗コードが入ります。

[
  {
    "id": "bb3c8cf4-371b-4f26-98fd-db7344409588",
    "request": {
      "title": "Hachiko test (discord)",
      "body": "Web UI からのテスト送信です",
      "channel": "discord",
      "metadata": {}
    },
    "status": "queued",
    "received_at": "2026-06-16T11:14:11.2956178Z",
    "processed_at": null,
    "error_code": null,
    "error_message": null
  }
]

status には次の値が入ります: queued, retry_waiting, sent, failed

最近の総件数、成功件数、再試行待ち件数、失敗件数と、最後の時刻情報を返します。

{
  "recent_total": 1,
  "recent_success_count": 0,
  "recent_retry_waiting_count": 1,
  "recent_failed_count": 0,
  "last_received_at": "2026-06-16T11:14:11.2956178Z",
  "last_sent_at": null,
  "last_failure_at": null
}

現在の設定内容をそのまま JSON で返します。

設定の一部だけを更新します。送った項目だけが反映されます。 この API で変えられるのは logging、file_watch、notification_targets です。 ポート変更はこの API ではなく、Tray の Change port and restart から行います。

{
  "notification_targets": {
    "discord": {
      "enabled": true,
      "settings": {
        "webhook_url": "https://discord.com/api/webhooks/..."
      }
    }
  }
}

{
  "updated": true,
  "reloaded_sections": [
    "notification_targets"
  ],
  "validation_errors": []
}

{
  "logging": {
    "enabled": true,
    "retention_days": 30
  },
  "file_watch": {
    "enabled": true,
    "watch_roots": [
      "C:\\watch"
    ],
    "recursive": true,
    "notify_on_created": true,
    "notify_on_deleted": true,
    "notify_on_size_changed": true,
    "notify_on_modified_time_changed": true,
    "notify_on_extension_changed": true
  }
}

存在しないフォルダを監視対象にした場合の例です。

{
  "updated": false,
  "reloaded_sections": [],
  "validation_errors": [
    {
      "category": "file_watch",
      "field": "watch_roots",
      "code": "path_not_found",
      "message": "file_watch.watch_roots path was not found: C:\\not-found"
    }
  ]
}

接続テストで通知先が無効な場合の例です。

{
  "ok": false,
  "mode": "connection",
  "queued": false,
  "notification_id": null,
  "message": "接続テストに失敗しました",
  "error_code": "target_disabled",
  "error_message": "discord target is disabled"
}