Skip To Content

管理 webhook

ArcGIS 11.4 (Windows)  | |  帮助归档

作为管理员,您可以通过更新 webhook 配置(例如更新 webhook 订阅的事件触发器)的方式对其进行更新和管理,还可以禁用和删除之前配置的 webhook。

更新 webhook

创建后,您可以更新为 webhook 配置的参数。 以下部分概述了如何更新组织和服务 webhook 的属性。

更新组织 webhook

要通过 ArcGIS Enterprise 门户网站更新组织 webhook,请按照以下步骤操作:

  1. 确认您以默认管理员身份或具有创建和管理组织 webhook 的管理权限的自定义角色成员的身份登录。
  2. 浏览至组织 > 设置 > Webhook
  3. 组织 webhook 下,找到要更新的 webhook。
  4. 单击选项按钮,然后单击编辑
  5. 编辑 webhook 窗口中,修改以下内容:
    1. 要更新 webhook 名称,在名称文本框中为 webhook 提供唯一名称。
    2. 要更新 webhook 类型,请单击类型下拉菜单 ,然后选择新 webhook 类型。
      • 选择全部可订阅所有受支持的事件触发器。 在每个事件发生时,您将收到通知。
      • 选择项目用户群组角色允许您手动定义要订阅的触发事件。
    3. 如果选择全部以外的 webhook 类型,则会出现一个与所选 webhook 类型相关的附加下拉菜单。 例如,如果您为 webhook 类型选择了项目,则会出现项目下拉菜单,允许您选择 webhook 将监控的特定项目。
    4. 要更新事件触发器,请单击事件下拉菜单,然后选择一个新的触发器事件。 例如,如果您希望在发布特定项目时调用 webhook,请选择 /items/<项目 ID>/publish
    5. 如果需要更新负载 URL,请选择 Webhook URL,然后提供 webhook 接收器的新负载 URL。
    6. 如果需要更新笔记本项目,请选择笔记本,然后选择将在触发 webhook 时运行的新笔记本。
    7. 或者,在密钥(可选) 文本框中添加一个作为 webhook 密钥的字母数字字符串,或者更新预先存在的密钥。 密钥值将用于生成包含在 webhook 有效负载标头中的签名。 webhook 接收器可以使用此签名来确定是否应信任该消息。
  6. 单击更新 webhook 以应用更改。

更新服务 webhook

要更新服务 webhook 的属性,请执行以下步骤:

  1. 确认您以默认管理员身份或具有创建和管理服务 webhook 的管理权限的自定义角色成员的身份登录。

    注:
    已分配发布者角色的成员将无法在 ArcGIS Enterprise 门户站点中创建或管理服务 webhook,并且需要使用管理 API 执行这些工作流

  2. 浏览至组织 > 设置 > Webhook
  3. 服务 webhook 下,找到要更新的 webhook。
  4. 单击选项按钮,然后单击编辑
  5. 编辑 webhook 窗口中,修改以下内容:
    1. 要更新 webhook 名称,在名称文本框中为 webhook 提供唯一名称。
    2. 要更新与 webhook 相关联的服务,请单击服务下拉菜单并选择新服务。

      注:

      选择地理处理服务可将事件设置为服务已完成。 选择要素服务将启用事件下拉菜单。

    3. 如果选择要素服务 webhook,请从事件下拉菜单中选择新的事件触发器。 例如,如果您希望在更新要素附件时调用 webhook,请选择 AttachmentsUpdated
    4. 如果需要更新负载 URL,请选择 Webhook URL,然后提供 webhook 接收器的新负载 URL。
    5. 或者,在密钥(可选) 文本框中添加一个作为 webhook 密钥的字母数字字符串,或者更新预先存在的密钥。 密钥值将用于生成包含在 webhook 有效负载标头中的签名。 webhook 接收器可以使用此签名来确定是否应信任该消息。
  6. 单击更新 webhook 以应用更改。

禁用 webhook

可以手动禁用 webhook,或者在满足禁用策略时进行禁用。 当 webhook 停用时,webhook 会暂停并且在触发时无法传送负载。 以下部分概述了如何禁用组织和服务 webhook。

禁用组织 webhook

要通过 ArcGIS Enterprise 门户网站禁用组织 webhook,请按照以下步骤操作:

  1. 确认您以默认管理员身份或具有创建和管理组织 webhook 的管理权限的自定义角色成员的身份登录。
  2. 浏览至组织 > 设置 > Webhook
  3. 组织 webhook 下,找到要禁用的组织 webhook,然后单击活动
  4. 单击确认以暂停 webhook。

禁用服务 webhook

要禁用服务 webhook,请执行以下操作:

  1. 确认您以默认管理员身份或具有创建和管理服务 webhook 的管理权限的自定义角色成员的身份登录。

    注:
    已分配发布者角色的成员将无法在 ArcGIS Enterprise 门户站点中创建或管理服务 webhook,并且需要使用管理 API 执行这些工作流

  2. 浏览至组织 > 设置 > Webhook
  3. 服务 webhook 下,找到要禁用的服务 webhook,然后单击活动
  4. 单击确认以暂停 webhook。

激活 webhook

当 webhook 停用时,无法传送负载。 重新激活 webhook 会重新启动 webhook,并使其能够在下一次调用 webhook 时传送负载。 以下部分概述了如何激活之前已禁用的组织和服务 webhook。

激活组织 webhook

要通过 ArcGIS Enterprise 门户网站启用组织 webhook,请按照以下步骤操作:

  1. 确认您以默认管理员身份或具有创建和管理组织 webhook 的管理权限的自定义角色成员的身份登录。
  2. 浏览至组织 > 设置 > Webhook
  3. 组织 webhook 下,找到要激活的组织 webhook,然后单击非活动
  4. 单击确认以重新启动 webhook。

激活服务 webhook

要激活服务 webhook,请执行以下操作:

  1. 确认您以默认管理员身份或具有创建和管理服务 webhook 的管理权限的自定义角色成员的身份登录。

    注:
    已分配发布者角色的成员将无法在 ArcGIS Enterprise 门户站点中创建或管理服务 webhook,并且需要使用管理 API 执行这些工作流

  2. 浏览至组织 > 设置 > Webhook
  3. 服务 webhook 下,找到要激活的服务 webhook,然后单击非活动
  4. 单击确认以重新启动 webhook。

删除 webhook

如果不再需要先前创建的 webhook,则可以通过删除 webhook 将其从组织中永久移除。 以下部分概述了如何删除组织和服务 webhook。

删除组织 webhook

要通过 ArcGIS Enterprise 门户网站更新组织 webhook,请按照以下步骤操作:

  1. 确认您以默认管理员身份或具有创建和管理组织 webhook 的管理权限的自定义角色成员的身份登录。
  2. 浏览至组织 > 设置 > Webhook
  3. 组织 webhook 下,找到要更新的组织 webhook。
  4. 单击选项按钮,然后单击删除
  5. 删除窗口中,单击确认按钮以永久删除 webhook。

删除服务 webhook

要删除服务 webhook,请执行以下操作:

  1. 确认您以默认管理员身份或具有创建和管理服务 webhook 的管理权限的自定义角色成员的身份登录。

    注:
    已分配发布者角色的成员将无法在 ArcGIS Enterprise 门户站点中创建或管理服务 webhook,并且需要使用管理 API 执行这些工作流

  2. 浏览至组织 > 设置 > Webhook
  3. 服务 webhook 下,找到要更新的服务 webhook。
  4. 单击选项按钮,然后单击删除
  5. 删除窗口中,单击确认按钮以永久删除 webhook。