{"title":"Webhooks API","slug":"webhooks","category":"api","summary":"メモリ、チャット、タスクイベントに対する HTTP コールバックの登録 — データ変更時に通知を受信。","audience":["human","llm"],"tags":["api","webhooks","automation","events"],"difficulty":"intermediate","updated":"2026-06-27","word_count":126,"read_minutes":1,"llm_context":"Auth: Mind Key\nRegister: POST /webhooks { url, events, secret? }\nList: GET /webhooks\nGet: GET /webhooks/:id\nUpdate: PUT /webhooks/:id { url?, events?, secret?, enabled? }\nDelete: DELETE /webhooks/:id\nEvents: memory.*, memory.store, memory.update, memory.delete, chat.*, chat.message_received, task.*, task.created, task.completed\nSecret: HMAC-SHA256 signed payload, sent in X-Synapse-Signature header\nPattern: register webhook → receive POST → process event → call Synapse API\n","lang":"ja","translated":true,"requested_lang":"ja","content_markdown":"\n# Webhooks API\n\nWebhooks を使用すると、Synapse でイベントが発生した際に HTTP コールバックを受信できます。外部自動化のトリガー、通知の送信、他システムへの同期に最適です。\n\n## エンドポイント\n\n### POST /webhooks\n\n新しい Webhook を登録します。\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/webhooks \\\n -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"url\": \"https://my-app.com/webhook\",\n \"events\": \"memory.*\",\n \"secret\": \"my-hmac-secret-min-8-chars\"\n }'\n```\n\nレスポンス：\n\n```json\n{\n \"id\": \"wh_001\",\n \"url\": \"https://my-app.com/webhook\",\n \"events\": [\"memory.*\"],\n \"enabled\": true,\n \"created_at\": \"2026-06-27T...\"\n}\n```\n\n### GET /webhooks\n\n現在の mind のすべての Webhook を一覧表示します。\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/webhooks\n```\n\n### GET /webhooks/:id\n\n単一の Webhook を取得します。\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/webhooks/wh_001\n```\n\n### PUT /webhooks/:id\n\nWebhook を更新します（URL、events、secret、enabled フラグ）。\n\n```bash\ncurl -X PUT https://synapse.schaefer.zone/webhooks/wh_001 \\\n -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"enabled\": false}'\n```\n\n### DELETE /webhooks/:id\n\nWebhook を削除します。\n\n```bash\ncurl -X DELETE -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/webhooks/wh_001\n```\n\n## イベント種別\n\n| パターン | 発生タイミング |\n|---------|------------|\n| `memory.*` | 任意のメモリイベント |\n| `memory.store` | 新規メモリの保存 |\n| `memory.update` | メモリの更新 |\n| `memory.delete` | メモリの削除 |\n| `chat.*` | 任意のチャットイベント |\n| `chat.message_received` | 人間からの新規メッセージ |\n| `task.*` | 任意のタスクイベント |\n| `task.created` | 新規タスクの作成 |\n| `task.completed` | タスクの完了マーク |\n| `*` | 全イベント |\n\n## Webhook ペイロード\n\nイベント発生時、Synapse はあなたの URL に POST リクエストを送信します。\n\n```json\n{\n \"event\": \"memory.store\",\n \"timestamp\": \"2026-06-27T...\",\n \"mind_id\": \"m_xyz789\",\n \"data\": {\n \"id\": \"mem_001\",\n \"category\": \"fact\",\n \"key\": \"user_name\",\n \"content\": \"Michael Schäfer\"\n }\n}\n```\n\n## 署名検証\n\n`secret` を設定すると、Synapse は各ペイロードを HMAC-SHA256 で署名します。\n\n```\nX-Synapse-Signature: sha256=\n```\n\nハンドラで検証します：\n\n```python\nimport hmac, hashlib\n\ndef verify_signature(payload_body: bytes, signature: str, secret: str) -> bool:\n expected = hmac.new(\n secret.encode(),\n payload_body,\n hashlib.sha256\n ).hexdigest()\n return hmac.compare_digest(f\"sha256={expected}\", signature)\n```\n\n## パターン：リアルタイム同期\n\n```python\n# Your webhook handler\n@app.post(\"/webhook\")\nasync def handle_webhook(request):\n body = await request.body()\n signature = request.headers.get(\"X-Synapse-Signature\", \"\")\n if not verify_signature(body, signature, WEBHOOK_SECRET):\n return 401\n\n event = json.loads(body)\n if event[\"event\"] == \"memory.store\":\n # Sync to another system\n sync_to_external(event[\"data\"])\n elif event[\"event\"] == \"chat.message_received\":\n # Trigger agent wake-up\n notify_agent(event[\"data\"])\n```\n\n## 次のステップ\n\n- [Cron & Scheduler](/docs/api/cron)\n- [Webhook Automation Guide](/docs/guides/webhook-automation)\n","content_html":"

Webhooks API

\n

Webhooks を使用すると、Synapse でイベントが発生した際に HTTP コールバックを受信できます。外部自動化のトリガー、通知の送信、他システムへの同期に最適です。

\n

エンドポイント

\n

POST /webhooks

\n

新しい Webhook を登録します。

\n
curl -X POST https://synapse.schaefer.zone/webhooks \\\n  -H "Authorization: Bearer YOUR_MIND_KEY" \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "url": "https://my-app.com/webhook",\n    "events": "memory.*",\n    "secret": "my-hmac-secret-min-8-chars"\n  }'

レスポンス：

\n
{\n  "id": "wh_001",\n  "url": "https://my-app.com/webhook",\n  "events": ["memory.*"],\n  "enabled": true,\n  "created_at": "2026-06-27T..."\n}

GET /webhooks

\n

現在の mind のすべての Webhook を一覧表示します。

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/webhooks

GET /webhooks/:id

\n

単一の Webhook を取得します。

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/webhooks/wh_001

PUT /webhooks/:id

\n

Webhook を更新します（URL、events、secret、enabled フラグ）。

\n
curl -X PUT https://synapse.schaefer.zone/webhooks/wh_001 \\\n  -H "Authorization: Bearer YOUR_MIND_KEY" \\\n  -H "Content-Type: application/json" \\\n  -d '{"enabled": false}'

DELETE /webhooks/:id

\n

Webhook を削除します。

\n
curl -X DELETE -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/webhooks/wh_001

イベント種別

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
パターン発生タイミング
memory.*任意のメモリイベント
memory.store新規メモリの保存
memory.updateメモリの更新
memory.deleteメモリの削除
chat.*任意のチャットイベント
chat.message_received人間からの新規メッセージ
task.*任意のタスクイベント
task.created新規タスクの作成
task.completedタスクの完了マーク
*全イベント
\n

Webhook ペイロード

\n

イベント発生時、Synapse はあなたの URL に POST リクエストを送信します。

\n
{\n  "event": "memory.store",\n  "timestamp": "2026-06-27T...",\n  "mind_id": "m_xyz789",\n  "data": {\n    "id": "mem_001",\n    "category": "fact",\n    "key": "user_name",\n    "content": "Michael Schäfer"\n  }\n}

署名検証

\n

secret を設定すると、Synapse は各ペイロードを HMAC-SHA256 で署名します。

\n
X-Synapse-Signature: sha256=<hex-hmac>

ハンドラで検証します：

\n
import hmac, hashlib\n\ndef verify_signature(payload_body: bytes, signature: str, secret: str) -> bool:\n    expected = hmac.new(\n        secret.encode(),\n        payload_body,\n        hashlib.sha256\n    ).hexdigest()\n    return hmac.compare_digest(f"sha256={expected}", signature)

パターン：リアルタイム同期

\n
# Your webhook handler\n@app.post("/webhook")\nasync def handle_webhook(request):\n    body = await request.body()\n    signature = request.headers.get("X-Synapse-Signature", "")\n    if not verify_signature(body, signature, WEBHOOK_SECRET):\n        return 401\n\n    event = json.loads(body)\n    if event["event"] == "memory.store":\n        # Sync to another system\n        sync_to_external(event["data"])\n    elif event["event"] == "chat.message_received":\n        # Trigger agent wake-up\n        notify_agent(event["data"])

次のステップ

\n\n","urls":{"html":"/docs/api/webhooks","text":"/docs/api/webhooks?format=text","json":"/docs/api/webhooks?format=json","llm":"/docs/api/webhooks?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}