Webhook とは
更新日
Webhook は、システム内でイベントが発生したときに、外部サーバーへ自動でデータを送信する仕組みです。API のポーリング（定期的に API を呼び出してデータを確認する方式）とは異なり、イベントが発生したタイミングでのみ通知が届くため、リソースの消費が少なく、リアルタイムに近い連携が実現できます。
Re:Earth CMS の Webhook を使用すると、プロジェクト内でアイテムやアセットの編集・削除・公開などの変更が行われた際に、外部サービスへリアルタイムで通知を送信できます。これにより、外部システムとの連携や自動化、データ同期が容易になります。
- アイテムの作成・更新・削除の通知
- アイテムの公開・非公開状態の変更通知
- 指定した URL への HTTP
POSTによるリアルタイム通知 - リクエスト内容が改ざんされていないことを確認するための署名付与
外部から CMS のデータを取得・操作したい場合は、インテグレーションAPI または パブリックAPI を使用します。
Webhook の主な特徴は次のとおりです。
| 特徴 | 内容 |
|---|---|
| CMS からのイベント通知を行う仕組み | アイテムの作成・更新・削除・公開などのイベントが発生すると、CMS 側から指定した URL へ HTTP POST リクエストを送信する。 |
| インテグレーションに紐づけて設定 | Webhook 単体では存在せず、1 つのインテグレーションに対して複数の Webhook を追加できる。 |
| 署名検証が必要 | リクエストにはシークレットによる署名が付与されるため、受信側で検証を行い、なりすましを防ぐ必要がある。 |
次のステップ
Section titled “次のステップ”まずは インテグレーションの作成 に進み、Webhook 設定の前提となるインテグレーションを作成しましょう。
- Getting started: Webhook の使い方 — 設定手順とイベントの種類