webhook — Webhook

コンテンツの変更を外部 URL に通知する Webhook を管理します。

すべて認証とプロジェクトコンテキストが必要です。

購読対象は「テーブル名:イベント種別」の形式で指定します。イベント種別は content.create / content.update / content.delete です。

`orizm webhook list`

Webhook の一覧を表示します。


orizm webhook list

`orizm webhook get`

Webhook の詳細を表示します。


orizm webhook get <id>

引数

引数	説明
`<id>`	Webhook の数値 ID。

`orizm webhook create`

Webhook を作成します。


orizm webhook create --name <name> --url <url> [--table-event <table>:<event>] [--header <key>:<value>]

オプション

オプション	説明
`--name <name>`	（必須）Webhook 名。
`--url <url>`	（必須）通知先 URL。
`--table-event <table>:<event>`	購読対象（複数指定可）。
`--header <key>:<value>`	通知時に付与するカスタムヘッダ（複数指定可）。


orizm webhook create --name "notify" --url https://example.com/hook \
  --table-event article:content.create --table-event article:content.update \
  --header X-Token:secret

`orizm webhook update`

Webhook を更新します。指定したオプションの項目だけが変更されます。


orizm webhook update <id> [--name <s>] [--url <u>] [--table-event <t>:<e>] [--add-table-event <t>:<e>] [--remove-table-event <t>:<e>] [--clear-table-events] [--header <k>:<v>] [--add-header <k>:<v>] [--remove-header <k>] [--clear-headers]

引数

引数	説明
`<id>`	Webhook の数値 ID。

オプション

オプション	説明
`--name <s>` / `--url <u>`	指定したときだけ更新します。
`--table-event <t>:<e>`	購読対象を全置換します（複数指定可）。
`--add-table-event <t>:<e>`	購読対象を追加します（複数指定可）。
`--remove-table-event <t>:<e>`	購読対象を削除します（複数指定可）。
`--clear-table-events`	購読対象をすべて削除します。
`--header <k>:<v>`	カスタムヘッダを全置換します（複数指定可）。
`--add-header <k>:<v>`	カスタムヘッダを追加します。同じ key は値を置き換えます（複数指定可）。
`--remove-header <k>`	key を指定してカスタムヘッダを削除します（複数指定可）。
`--clear-headers`	カスタムヘッダをすべて削除します。

tableEvents と customHeaders はいずれも、全置換系（--table-event / --clear-table-events、--header / --clear-headers）と編集系（--add-* / --remove-*）を同時に指定できません。存在しない対象の削除は無視されますが、タイポに気づけるよう通知が出ます。


# article テーブルの delete イベントを購読に追加する
orizm webhook update 7 --add-table-event article:content.delete

`orizm webhook delete`

Webhook を削除します。


orizm webhook delete <id> [--yes]

引数

引数	説明
`<id>`	Webhook の数値 ID。

オプション

オプション	説明
`--yes`	確認プロンプトをスキップします。