Webhook の使い方
更新日
このページでは、CMS の変更イベントを外部サービスへ自動通知するために Webhook を設定する方法を説明します。
インテグレーションの作成
Section titled “インテグレーションの作成”Webhook はインテグレーション画面から設定します。まずは Re:Earth CMS の管理画面で、対象プロジェクト（必要に応じてワークスペース）のインテグレーションを作成してください。手順は インテグレーションの作成 を参照してください。
-
マイインテグレーションからインテグレーションをクリックし、詳細ページを開きます
-
Webhook タブを開きます
-
＋新規 Webhook ボタンをクリックします
-
以下の情報を埋めて、保存ボタンをクリックします
- 名前
- URL — 通知先の URL。
POSTリクエストを受信できる有効な URL である必要があります - シークレット（Secret） — ここで設定したシークレットは Webhook のリクエストを署名する際に使用されます。受信側でその署名を検証することで、正当な送信元かどうかを確認できます
- Webhook を作動させるイベント（複数選択可）
イベントの種類
Section titled “イベントの種類”Webhook が作動するイベントを選択します。選択したイベントが発生するたびに、指定 URL に POST リクエストが送信されます。複数選択可能です。
| イベント | タイミング |
|---|---|
| 作成 | 新規アイテムが作成されたとき |
| 更新 | アイテムが更新されたとき |
| 削除 | アイテムが削除されたとき |
| 公開 | アイテムが公開されたとき |
| 非公開 | アイテムが非公開に設定されたとき |
| イベント | タイミング |
|---|---|
| アップロード | 新規アセットがアップロードされたとき |
| 圧縮 | ZIP ファイルなどのアセットが解凍されたとき |
| 削除 | アセットが削除されたとき |
Webhook を保存したら、設定した対象のイベントを実行してみましょう。対象のイベントを実行すると、指定した URL へ通知が届きます。