Webhook
Webhookとは
パレットCMSで特定の操作が行われた際、外部サービスに情報を通知することができます。
Webhookの通知条件
Webhookの通知条件は以下のとおりです。対象情報に対し、それぞれ登録・編集・削除の操作が行われた際に情報が通知先URLに送信されます。
- 通知対象情報
- userモジュール、itemモジュール、entryモジュール、formモジュール
- リクエストメソッド
- 登録:POST 編集:PUT 削除:DELETET
各権限の操作状況による通知条件
各権限、対象情報に対して以下の操作をした場合に通知されます。APIから該当操作を行った場合も実行されます。
※CSVによる操作は実行されません。
対象情報 | 発生イベント |
---|---|
user | 登録、編集、削除 ※管理画面の一覧リストより一括変更(削除)、コンテンツ側からの退会・編集操作も含まれます。 |
item | 登録、編集、削除 ※管理画面の一覧リストより一括変更(削除)した場合も通知されます。 |
entry | 登録、編集、削除 ※管理画面の一覧リストより一括変更(削除)した場合も通知されます。 |
form | 登録、編集、削除 ※管理画面の一覧リストより一括削除した場合も通知されます。 |
通知条件の登録と通知ログ
通知設定は、設定 > 運用設定 > Webhook管理 > Webhook設定 より行います。
通知条件を選択し、通知先URL、通知フォーマット(json、x-www-form-urlencoded ※いずれかを選択)を設定してください。
設定後、所定の条件で通知されているかは、Webhook通知ログ一覧 で確認します。「通知先URL」のリンクよりログ詳細も参照できます。