负载

触发 webhook 后，负载将传送到指定的负载 URL。 特定 webhook 类型的每个事件都遵循类似的 JSON 模式，其中包含与支持的事件相关的信息。 以下部分定义了负载中包含的属性，并提供了组织和服务 webhook 的示例负载。

组织 webhook 负载

下表列出了组织 webhook 负载中的属性，返回对组织中的用户、群组、项目和角色的更改和更新。

属性	描述
webhookName	传送负载的 webhook 的名称。
webhookId	传送负载的 webhook 的 ID。
portalURL	Webhook 注册的门户的 URL。
when	传送负载的时间。
username	触发事件的用户。
userId	触发事件的用户的 ID。
when	事件发生的时间。
operation	用户执行的操作类型。 下方列表概述了负载中返回的操作类型属性及其关联的 Portal Directory API 操作： add：添加项目、创建群组、创建角色 addUsers：将用户添加到群组 delete：删除项目、删除群组、删除用户、删除角色 disable：禁用用户 enable：启用用户 invite：邀请加入群组 move：移动项目 protect：保护群组 publish：发布项目 removeUsers：从群组中移除用户 share：共享项目 unprotect：取消保护群组 unshare：取消共享项目 update：更新项目、更新群组、更新用户、更新角色
source	执行操作所针对的项目类型。 可以是 items、group 或 user。
id	执行操作所针对的源项目的 ID。
properties	与特定事件触发器关联的其他属性。 以下列表概述了负载中包含的其他属性。 有关事件触发器包含其他属性的详细信息，请参阅事件触发器，或单击下方属性以了解有关特定触发器及其属性的详细信息。 sharedToGroups unsharedFromGroups removeUserNames updateUserNames invitedUserNames addedUserNames userRoleUpdatedTo reassignedTo userLicenseTypeUpdatedTo name

负载示例

以下示例说明了在特定群组被更新时触发的组织 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
when	事件发生时的时间戳（格式化为自新纪元以来的毫秒数）。

负载示例

以下示例说明了要素服务 webhook 的示例负载，此 webhook 将在要素服务被更新 (FeaturesUpdated)、删除 (FeaturesDeleted) 和编辑 (FeaturesEdited) 时触发。

{
  "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
    }
  ]
}