CLI:Webhook
Webhook を作る、変える、削除するコマンドと、送った記録を見る、送り直すコマンドです。どのコマンドにも付けられる共通のフラグ(--host、--json など)は CLI のコマンドのリファレンス にあります。
届く中身は Webhook を受け取る にあります。
| コマンド | 内容 |
|---|---|
hakocms-cli webhooks create |
Webhook を作る |
hakocms-cli webhooks delete |
Webhook を削除する |
hakocms-cli webhooks deliveries list |
Webhook の送信履歴 |
hakocms-cli webhooks deliveries redeliver |
送った Webhook を、同じ本文で送り直す |
hakocms-cli webhooks get |
Webhook を取得する |
hakocms-cli webhooks list |
Webhook の一覧 |
hakocms-cli webhooks test |
テストの Webhook をすぐに送り、結果を出す |
hakocms-cli webhooks update |
Webhook の設定を変える |
hakocms-cli webhooks create
Section titled “hakocms-cli webhooks create”Webhook を作る。
hakocms-cli webhooks create [OPTIONS]| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
--content-type-id <TEXT> |
このコンテンツタイプのイベントだけを送る。null ならすべてのコンテンツタイプとメディア |
--enabled[=true|false] |
送るか。既定 true |
--events <JSON> |
送るイベント名の配列。既定 [“entry.published”, “entry.deleted”] |
--headers <JSON> |
カスタムヘッダー(名前から値のオブジェクト)。20 個まで |
--name <TEXT> |
名前 |
--preset <TEXT> |
送る形。選べる値:custom, vercel, netlify, slack。既定 custom |
--secret-stdin |
署名のシークレット(8〜256 文字)。標準入力の 1 行目から読む |
--url <TEXT> |
送信先(http:// か https://) |
--data <JSON> |
本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる |
hakocms-cli webhooks delete
Section titled “hakocms-cli webhooks delete”Webhook を削除する。
hakocms-cli webhooks delete [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
--force |
確かめずに行う |
hakocms-cli webhooks deliveries list
Section titled “hakocms-cli webhooks deliveries list”Webhook の送信履歴。
hakocms-cli webhooks deliveries list [OPTIONS] --webhook <TEXT>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
--webhook <TEXT> |
ID(必須) |
--limit <N> |
出す件数(既定 30) |
--all |
全部のページをたどる |
hakocms-cli webhooks deliveries redeliver
Section titled “hakocms-cli webhooks deliveries redeliver”送った Webhook を、同じ本文で送り直す。
手動の再送:同じ本文(deliveryId も同じ)を、新しい送信として最初から送り直す。
hakocms-cli webhooks deliveries redeliver [OPTIONS] --webhook <TEXT> <DELIVERY_ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
--webhook <TEXT> |
ID(必須) |
<DELIVERY_ID> |
送信の ID |
hakocms-cli webhooks get
Section titled “hakocms-cli webhooks get”Webhook を取得する。
hakocms-cli webhooks get [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
hakocms-cli webhooks list
Section titled “hakocms-cli webhooks list”Webhook の一覧。
hakocms-cli webhooks list [OPTIONS]| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
hakocms-cli webhooks test
Section titled “hakocms-cli webhooks test”テストの Webhook をすぐに送り、結果を出す。
テストの送信。すぐに送って結果を返す(再送しない、データの操作に結び付かないので、ジョブを使わない)
hakocms-cli webhooks test [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
hakocms-cli webhooks update
Section titled “hakocms-cli webhooks update”Webhook の設定を変える。
hakocms-cli webhooks update [OPTIONS] <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
<ID> |
ID |
--content-type-id <TEXT> |
このコンテンツタイプのイベントだけを送る。null ならすべてのコンテンツタイプとメディア |
--enabled[=true|false] |
送るか |
--events <JSON> |
送るイベント名の配列 |
--headers <JSON> |
カスタムヘッダー(名前から値のオブジェクト)。20 個まで |
--name <TEXT> |
名前 |
--preset <TEXT> |
送る形。選べる値:custom, vercel, netlify, slack |
--secret-stdin |
署名のシークレット(8〜256 文字)。null で外す。標準入力の 1 行目から読む |
--url <TEXT> |
送信先(http:// か https://) |
--data <JSON> |
本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる |