コンテンツにスキップ

未翻訳のページは英語で開き、英語と表示されます。

このページは英語の原文の機械翻訳です。内容は英語の原文が優先されます。 Machine-translated from the English page, which is authoritative.

webhook オペレーション

各 webhook.* オペレーションが受け取るフィールドと返すフィールドの詳細です。

すべてのオペレーションは、HTTP では POST /v1/<op>、MCP ではツール loom_<op> として使えます。ID フィールド(org、namespace、agent、user_id、session_id)は、トランスポートが対応している場合にトークンと MCP セッションから補われます。シングルユーザーサーバーでトークンなしに HTTP 呼び出しを行う場合は、code.* と tracker.*(それぞれのプレーンの値を保持します)を除くすべてのオペレーションでインストールの org が補われ、一部のオペレーションでは名前空間とエージェントも補われます。詳しくは ID と名前空間を参照してください。ロール、種別、MCP の all 一覧についてはオペレーション一覧で説明しています。未知の入力フィールドは受け付けられ、ignored_args に名前が示されます。

webhook.deliveries

名前空間の直近 3 日間の webhook イベントと、その配信状態を返します。

POST /v1/webhook.deliveries · MCP loom_webhook_deliveries · ロール admin · 冪等 · MCP の all ツールセットには含まれません

入力フィールド 型 デフォルト 説明
org str 必須 テナント(ID タプルの最初の要素)。
namespace str 必須 オペレーションが読み書きする名前空間。
webhook_id str '' この webhook のイベントのみ。"" の場合は名前空間のすべての webhook が対象。
status Literal['pending', 'delivered', 'dead'] \| None None この状態のイベントのみ。None の場合はすべての状態が対象。
limit int 100 返すイベントの最大数。新しい順、1〜500。
出力フィールド 型 説明
deliveries list[WebhookDelivery] イベント。新しい順。

webhook.list

名前空間のメモリ webhook の一覧を返します。

POST /v1/webhook.list · MCP loom_webhook_list · ロール admin · 冪等 · MCP の all ツールセットには含まれません

入力フィールド 型 デフォルト 説明
org str 必須 テナント(ID タプルの最初の要素)。
namespace str 必須 オペレーションが読み書きする名前空間。
出力フィールド 型 説明
webhooks list[WebhookInfo] 名前空間の有効な登録。古い順。

webhook.register

名前空間内のメモリが変更されたときに通知を受ける URL を登録します。

POST /v1/webhook.register · MCP loom_webhook_register · ロール admin · 冪等 · 監査対象 · MCP の all ツールセットには含まれません

入力フィールド 型 デフォルト 説明
org str 必須 テナント(ID タプルの最初の要素)。
namespace str 必須 オペレーションが読み書きする名前空間。
url str 必須 イベントを POST する送信先。https の URL(http はデプロイメントが許可する場合のみ)で、ホストがパブリックアドレスに解決されるもの。
secret_ref str 必須 署名シークレットを保持する環境変数の名前(シークレット自体ではありません):LOOM_WEBHOOK_SECRET_<ORG>__<NAME>。ORG は org ID を大文字にし、a-z と 0-9 以外のバイトを _ と 2 桁の 16 進数に置き換えたものです。
events list[Literal['memory.written', 'memory.revised', 'memory.tombstoned', 'memory.restored', 'memory.redacted', 'memory.erased']] (計算される) 送信するイベントタイプ。デフォルトはすべて。
出力フィールド 型 説明
webhook WebhookInfo 保存された登録内容。

webhook.remove

メモリ webhook を 1 件削除します。すでに送信中の POST を除き、呼び出し後はこの webhook のイベントは送信されません。

POST /v1/webhook.remove · MCP loom_webhook_remove · ロール admin · 冪等 · 監査対象 · MCP の all ツールセットには含まれません

入力フィールド 型 デフォルト 説明
org str 必須 テナント(ID タプルの最初の要素)。
namespace str 必須 オペレーションが読み書きする名前空間。
webhook_id str 必須 webhook.register または webhook.list が返した webhook_id。
出力フィールド 型 説明
removed bool その ID の有効な webhook が名前空間にない場合は False。