Webhook がトリガーされると、ペイロードが特定のペイロード URL に配信されます。 特定の Webhook タイプの各イベントは、対応するイベントに関連する情報を含む同様の JSON スキーマに従います。 以下のセクションでは、ペイロードに含まれるプロパティを定義し、組織 Webhook とサービス Webhook のペイロードの例を示します。
組織 Webhook のペイロード
次の表は、組織 Webhook のペイロードに含まれるプロパティを示し、組織内のユーザー、グループ、アイテム、およびロールの変更と更新に関する情報を返します。
| プロパティ | 説明 |
|---|---|
| webhookName | ペイロードを配信した Webhook の名前。 |
| webhookId | ペイロードを配信した Webhook の ID。 |
| portalURL | Webhook が登録されているポータルの URL。 |
| when | ペイロードが配信された時刻。 |
| username | イベントをトリガーしたユーザー。 |
| userId | イベントをトリガーしたユーザーの ID。 |
| when | イベントが発生した時刻。 |
| operation | ユーザーが実行した操作タイプ。 以下のリストでは、ペイロードで返される操作タイプ プロパティと、関連する Portal Directory API 操作の概要を説明します。 |
| source | 操作が実行されたアイテム タイプ。 items、group、または user のいずれかです。 |
| id | 操作が実行されたソース アイテムの ID。 |
| properties | 特定のイベント トリガーに関連付けられているその他のプロパティ。 次のリストに、ペイロードに含まれるその他のプロパティの概要を示します。 その他のプロパティが含まれるかイベント トリガーの詳細については、「イベント トリガー」を参照するか、以下のプロパティをクリックして特定のトリガーとそのプロパティの詳細をご参照ください。 |
ペイロードの例
次の例は、特定のグループが更新されたときにトリガーされる組織 Webhook のサンプル ペイロードを示しています。
{
"info": {
"webhookName": "Group monitoring",
"webhookId": "72fed926aeb74c9ca8a22aacddc6725a",
"portalURL": "https://orgURL/portal/",
"when": 1543192196521
},
"events": [
{
"username": "administrator",
"userId": "173dd04b69134bdf99c5000aad0b6298",
"when": 1543192196521,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}ジオプロセシング サービス Webhook のペイロード
次の表は、ジオプロセシング サービス Webhook のペイロードに含まれるプロパティを示し、ジオプロセシング サービスに加えられた変更に関する情報を返します。
| プロパティ | 説明 |
|---|---|
| serviceType | Webhook が構成されたサービス タイプ。 フィーチャ サービス Webhook の場合、このプロパティは GPServer のみを返します。 |
| jobId | ジオプロセシング サービス ジョブの ID |
| statusURL | ポーリングしてジョブのステータス情報が返される、ジオプロセシング サービス ジョブのステータス URL。 |
| name | Webhook 名。 |
| taskName | ジオプロセシング ツール名。 |
| folderName | ジオプロセシング サービスが配置されているフォルダー。 |
| serviceName | ジオプロセシング サービスの名前。 |
| eventType | ジオプロセシング サービス ジョブが完了した状態を表すプロパティ。 ジオプロセシング サービス Webhook は特定のイベント トリガーに登録されていません。 その代わりに、ジオプロセシング サービスのジョブが完了すると、これらの Webhook はそのペイロードを配信します。 これらのペイロードは、ジョブが正常に完了したこと (esriJobSucceeded)、正常に完了しなかったこと (esriJobFailed)、またはジョブがキャンセルされたこと (esriJobCancelled) を示します。 値: esriJobSucceeded | esriJobFailed | esriJobCancelled |
| when | ジョブが完了したときのタイムスタンプ (エポックからのミリ秒)。 |
ペイロードの例
次の例は、ジオプロセシング サービス ジョブが完了した際にトリガーするジオプロセシング サービス Webhook のサンプル ペイロードを示しています。
{
"serviceType": "GPServer",
"jobId": "jeccad3d9099d4e1591859fdb08f4d1eb",
"statusURL": https://machine.domain.com/webadaptor/rest/services/my_Service/GPServer/jobs/jeccad3d9099d4e1591859fdb08f4d1eb?f=pjson,
"name": "webhook1",
"taskName": "",
"folderName": "",
"serviceName": "my_Service",
"events": [
{
"eventType": "esriJobSucceeded",
"when": 1652458959318
}
]
}フィーチャ サービス Webhook のペイロード
次の表は、フィーチャ サービス Webhook のペイロードに含まれるプロパティを示し、フィーチャ サービスに加えられた変更に関する情報を返します。
| プロパティ | 説明 |
|---|---|
| serviceType | Webhook が構成されたサービス タイプ。 フィーチャ サービス Webhook の場合、このプロパティは FeatureServer のみを返します。 |
| changesUrl | サービスの変更の抽出エンドポイントの URL。 ペイロードにはイベント トリガーと発生時間のみが含まれていますが、この URL にアクセスして、イベント中に発生した特定の変更の詳細を確認できます。 |
| id | ペイロードを配信した Webhook の ID。 |
| folderName | フィーチャ サービスが配置されているフォルダー。 |
| serviceName | フィーチャ サービスの名前。 |
| eventType | フィーチャ サービスで実行されるイベント タイプ。 Webhook を構成する際に登録できる変更タイプの値の詳細については、「イベント トリガー」トピックをご参照ください。 値: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged | FeaturesPosted |
| when | イベントが発生したときのタイムスタンプ (エポックからのミリ秒)。 |
ペイロードの例
次の例は、フィーチャ サービスが更新 (FeaturesUpdated)、削除 (FeaturesDeleted)、および編集 (FeaturesEdited) された際にトリガーするフィーチャ サービス Webhook のサンプル ペイロードを示しています。
{
"serviceType": "FeatureServer",
"changesUrl": "https://machine.domain.com/webadaptor/rest/services/Hosted/my_Service/FeatureServer/extractChanges?serverGens=12942,13026",
"id": "84e17696-c9d8-43cc-9cf7-5aeb658db12b",
"folderName": "Hosted",
"serviceName": "my_Service",
"events": [
{
"eventType": "FeaturesUpdated",
"when": 1652459863334
},
{
"eventType": "FeaturesDeleted",
"when": 1652459863334
},
{
"eventType": "FeaturesEdited",
"when": 1652459863334
}
]
}