Webhook は、Web アプリケーションまたはサービスがほぼリアルタイムで別の Web サービスに情報を送信することができる方法です。 この通信は、指定のイベントまたは定義したイベントによってトリガーされます。 更新を繰り返しチェックするのではなく、システムはトリガー イベントが発生するとただちに通知を送信します。
ArcGIS Online では、ホスト フィーチャ レイヤー、ホスト フィーチャ レイヤー ビュー、ホスト テーブルで Webhook を作成できます。 これらの Webhook は、定義されたイベント トリガーに基づいて Webhook レシーバーにペイロードを送信します。 レシーバーは、編集内容を定義済みの受信者リストに通知したり、編集内容に関する情報を外部アプリにエクスポートして変更レポートを作成したり、編集されたデータに対して品質管理スクリプトを実行したりするなどの自動アクションを実行するように構成されています。
この通信チャネルの構成は次のとおりです:
- イベント トリガー - 各イベント トリガーは、Webhook を呼び出すアイテムのソース フィーチャ上で実行され、API 操作を指定します。 イベント トリガーとして指定されている操作をユーザーが実行すると、Webhook は Webhook レシーバーにその情報を (ペイロードとして) 配信します。 Webhook を作成するときにトリガーを指定します。 設定可能なイベント トリガーについては、「フィーチャ レイヤー イベント トリガー」をご参照ください。
- ペイロード - ペイロードには、トリガー イベントに適した情報が含まれます。 ペイロードに含まれる情報については、「フィーチャ レイヤー Webhook のペイロード」をご参照ください。
- Webhook レシーバー - Webhook レシーバーは、ペイロードを受け取り、情報を定義済みの受信者リスト (ユーザーまたはアプリ) に送信します。 たとえば、ユーザーにトリガー イベントが発生したことを通知する電子メールまたはテキスト メッセージを送信する、トリガー イベントに関する情報を外部データベースに履歴管理のために送信する、発生したトリガー イベントに基づいてデータ上でスクリプトを実行する、といったことが可能です。
サードパーティー Web サービス レシーバーやカスタム Web サービスを Webhook レシーバーとして使用できます。 HTTPS 接続を介して通信してペイロードを受信するように Webhook レシーバーを構成する必要があります。また、ArcGIS Online 組織がレシーバーにアクセスできる状態でアイテムに Webhook を追加する必要があります。 Webhook レシーバーは、Webhook を作成したときに指定したペイロード URL を介してアクセスされます。
Webhook レシーバーは ArcGIS Online 外で構成されます。 レシーバーを構成した後で、Webhook を作成できます。
要件
ホスト フィーチャ レイヤー、ホスト フィーチャ レイヤー ビュー、またはテーブルの Webhook を作成するには、アイテムが次の要件を満たしている必要があります:
- [データの変更 (フィーチャの追加、更新、削除) を記録する] 設定が有効になっている。
- アイテムがゴミ箱に入っていない。
各アイテムには Webhook を 10 個まで作成できます。
Webhook の作成
ホスト フィーチャ レイヤー、ホスト フィーチャ レイヤー ビュー、ホスト テーブルの Webhook を作成および管理できる組織のメンバーのタイプを、Webhook を管理できる場所に関する情報と共に、次の表に示します。
| 組織のメンバーのタイプ | Webhook を管理できる場所 |
|---|---|
デフォルト管理者ロールのメンバーまたは Webhook を作成および管理できる管理権限のセットを持つカスタム ロールのメンバー。 |
|
アイテムの所有者 |
|
アイテムが共有されている共有更新グループのメンバー | ホスト フィーチャ レイヤー、ビュー、またはテーブルのアイテム ページの [設定] タブ - グループのメンバーは、特定のアイテムの Webhook を作成および管理できます。 |
組織内で割り当てられているロールに合わせた手順に従って Webhook を作成します:
- 組織の管理者
- アイテムが共有されている共有更新グループのアイテムの所有者またはメンバー