Webhook—ArcGIS Survey123

Webhook 允许多个应用程序彼此间进行交互，同时使用 HTTP POST 请求在这些应用程序之间传递回调。有关详细信息，请参阅 webhook 上的 Wikipedia 页面。 webhook 的常见用途包括通过电子邮件或 SMS 发送通知、向社交媒体发布消息、自动将记录写入电子表格，以及更新企业级数据库。

在 Survey123 中，可以在创建或删除要素图层中的记录或提交调查响应时设置和激活 webhook。例如，在向要素图层成功提交信息后，可以调用 webhook 并触发另一个操作，例如发送通知电子邮件、将调查内容附加到电子表格以及发送警告。

警告：

当您为调查创建或修改 Webhook 时，必须在 Survey123 外业应用程序中更新调查以使更改生效。

尽管您的工作场所可能有自己的 webhook 提供程序，但同时还有各种第三方工作流服务可供使用，例如 Microsoft Power Automate、Make、Zapier 和 tray.io。上述服务均可用于结合 Survey123，以触发自动化过程。

Microsoft Power Automate 和 Make 还包含工作流组件，用于辅助创建配合 Survey123 使用的 Webhook。

Survey123 支持的 webhook 类型

Survey123 支持两种类型的 webhook：

要素图层 webhook - 存储在调查的要素图层或要素图层视图中，并通过其触发。
Survey123 webhook - 存储在调查的表单项，并通过外业应用程序或 web 应用程序触发。

Microsoft Power Automate 包含一个 ArcGIS 连接器，可帮助设置要素图层 Webhook 或 Survey123 Webhook。要了解更多信息，请参阅 ArcGIS 连接器。以下用于帮助设置 Survey123 Webhook 的工作流组件将继续可用，但不再进行更新：

Microsoft Power Automate—Survey123 连接器
Make—Survey123 模块

如何设置 Webhook 的示例

您可通过多种方式将 Survey123 用作您工作流中的触发器。本节中的前三个示例均基于同一场景（当发送的响应中包含一个特定值的回答时，发送一封通知邮件），但每个示例所采用的第三方工作流组件或 Webhook 类型各不相同。最后一个示例假定您已创建自定义 Webhook（未使用 Microsoft Power Automate 连接器或 Make 模块），并介绍了如何将 webhook 添加到 Survey123 中。

请参阅以下示例：

在 Microsoft Power Automate 中设置要素图层 webhook

要在 Microsoft Power Automate 中设置要素图层 webhook，请完成以下步骤：

注：

用于在 Power Automate 中创建工作流的 ArcGIS Online 凭据将在两周后自动登出。如果您在 Power Automate 中无法浏览预期调查，请确认您的 Survey123 数据连接为活动状态。有关详细信息，请参阅快速提示：保持 ArcGIS Connectors for Power Automate 刷新令牌有效博客文章。

要在 Microsoft Power Automate 中使用 ArcGIS 或 ArcGIS Enterprise 连接器设置工作流，请完成以下步骤：如果您之前使用 Survey123 连接器创建了工作流，其仍然有效，但仅向 ArcGIS 和 ArcGIS Enterprise 连接器添加新功能。有关详细信息，请参阅 ArcGIS connectors for Power Automate 中的 Survey123 触发器和操作博客文章。

打开 Microsoft Power Automate。
从页面侧菜单中选择创建。
从从空白开始项中选择自动云流。
随即出现构建自动云流对话框。
对该工作流进行命名。
接下来，您需要选择一个触发器。
在搜索栏中输入 ArcGIS，然后选择在要素图层中创建记录时作为此工作流中的触发器。
单击创建。
使用您的 ArcGIS 组织凭据进行登录，然后选择希望监控的要素图层。
您必须选择接收提交的要素图层或要素图层视图。
在此工作流中添加从要素图层中获取更改、更新或删除操作。
1. 将更改 URL 设置为更改获取位置的输入。
2. 将 layerId 设置为要素图层 ID 的输入。
选择 Office 365 Outlook - 发送电子邮件 (V2)。
如果凭据尚未保存，请使用凭据登录邮件服务。
填写电子邮件的收件人、主题和正文字段。
您可利用在选择文本框时出现的动态内容对话框，根据需要插入调查响应的内容。
完成电子邮件后，单击保存。

Webhook 已完成，并且默认处于活动状态。现在，webhook 将每 30 秒运行一次。

在 Microsoft Power Automate 中设置 Survey123 webhook

要在 Microsoft Power Automate 中设置 Survey123 webhook，请完成以下步骤：

注：

打开 Microsoft Power Automate。
从页面侧菜单中选择创建。
从从空白开始项中选择自动云流。
随即出现构建自动云流对话框。
对该工作流进行命名。
接下来，您需要选择一个触发器。
在搜索栏中键入 ArcGIS，然后选择提交调查响应时。
单击创建。
使用您的 ArcGIS 组织凭据进行登录。
可以从调查的下拉列表中选择要用于 webhook 的调查。
您现在已经为 webhook 设置了触发器；但是，要将 webhook 设置为使用此触发器执行操作，您还需要执行其他步骤。
当问题以某种方式得到解答时，此工作流必须发送电子邮件；因此您需要提供一个条件。
单击新建步骤按钮，然后在操作部分顶部选择条件。
单击最左侧的文本框以打开一个对话框，以从调查中选择问题或属性，然后选择您希望用于限定调查的调查问题。
在中间的文本框中，从下拉菜单中选择 is equal to 条件作为触发器，因为您正在寻找准确的响应。
在最右边的文本框中，键入您希望据此发送通知的问题的值。
您希望仅在满足该条件时发送此电子邮件。
请单击如果是框中的添加操作。
如果否框保留为空。
许多邮件服务具有可用于此流的连接器。
选择 Office 365 Outlook - 发送电子邮件 (V2)。
如果凭据尚未保存，请使用凭据登录邮件服务。
填写电子邮件的收件人、主题和正文字段。
您可利用在选择文本框时出现的动态内容对话框，根据需要插入调查响应的内容。
完成电子邮件后，单击保存。

Webhook 已完成，并且默认处于活动状态。现在，webhook 将在每次提交具有给定条件的调查响应时运行。

提示：

可以使用创建报告操作生成调查响应的报告。

在 Make 中设置 Survey123 webhook

要在 Make 中设置 Survey123 webhook，请完成以下步骤：

转到 https://www.make.com/ 并登录。
在方案页面上，单击创建新方案按钮。
单击屏幕中间的模块图标。搜索 Survey123 并将其选中。
选择监视调查触发模块。
此模块用于在每次提交调查响应时运行方案。
将出现一个弹出窗口，用于帮助您配置监视调查模块。
提示：
创建报告模块可用于生成调查响应的报告。
单击添加并提供 webhook 的名称。
此名称对于您正在为其配置 webhook 的调查应该唯一。
如果您首次在 Make 中使用 Survey123 模块，则需要设置与 ArcGIS 组织的连接。在连接下，单击添加并为 ArcGIS 的连接命名。
您只需执行一次，因为 Make 将保存您的信息以供将来使用。
- 要连接到 ArcGIS Online，请单击保存以登录到您的 ArcGIS 组织。
- 要连接到 ArcGIS Enterprise，请将 Make 注册到您的门户。有关详细信息，请参阅 Survey123 诀窍：Make 博客文章。
从 ArcGIS 组织中选择要连接的调查。
考虑要包含在 webhook 中的选项，然后单击保存。
建议保留所有高级设置的默认值是，从而可在自定义 webhook 时为您提供最大的灵活性。
单击确定。
随即创建您的 webhook 并配置监视调查模块。
单击监视调查模块右侧的添加另一个模块按钮以将另一个模块连接到该模块。
搜索 Email，然后选择 Email 模块。
选择发送电子邮件操作。
如果您首次在 Make 中使用此模块，请单击添加以设置与电子邮件账户的连接。选择连接类型并登录到您的账户。
您只需执行一次，因为 Make 将保存您的连接以供将来使用。
添加收件人电子邮件地址。
这是触发电子邮件将发送到的电子邮件地址。
单击主题文本框。从调查中选择相应字段，以使用随即显示的模块设置面板来构造电子邮件主题。
在内容文本框中单击。从调查中选择相应字段，以使用随即显示的模块设置面板来构造电子邮件的内容。
可以使用 HTML 来格式化内容。
单击确定。
当问题以某种方式得到解答时，此方案必须发送电子邮件；因此您需要提供一个过滤器。
单击两个模块之间的工具按钮，然后选择设置过滤器。
在条件文本框中单击，然后从调查中选择要在过滤器中使用的字段。
为条件选择运算符。在本例中，选择默认值 Equal to。
输入条件的值，然后单击确定。
单击保存以保存您的方案。
或者，可以单击运行一次以测试您的 webhook。单击运行一次后，请打开 Survey123 并提交调查，确保调查响应满足过滤条件。确认收件人将收到电子邮件。
使用页面左下角的切换按钮以激活方案。将计划设置为立即以确保每次提交调查响应时，该方案都会运行。
要了解将 Survey123 用作 Make 方案触发器的其他方法，请参阅 Survey123 集成。

在 Survey123 网站中添加 webhook

Survey123 webhook 或要素图层 webhook 都可以添加到网站中。以下步骤显示设置要素图层 webhook 的方法。 Survey123 Webhook 相同，但额外提供了在事件负载属性中列出的事件数据选项。

在我的调查页面上，从位于调查面板右下角的菜单中选择设置选项卡。
从左侧菜单中选择 Webhook 部分。
通过此页面，您可以设置和访问已设置的所有 webhook。如果在 Survey123 中没有设置任何 webhook，则页面将为空。
单击添加 webhook，然后选择添加要素图层 webhook。
随即显示一个新面板，您可以在此页面中设置 webhook 与调查间的交互方式。
为您的 webhook 提供一个名称，该名称此后将用于识别您的 webhook。

负载 URL 是调查信息所发送到的位置。该 URL 必须由外部 webhook 服务提供。当您使用诸如 Microsoft Power Automate 或 Make 等服务创建 webhook 时，将在此页面上自动填充负载 URL。诸如 Zapier 或 FME Server 等其他服务将提供可供您复制到此页面上的负载 URL。其他应用程序可能需要您创建专用服务以侦听 webhook。

触发事件用于描述将调用 webhook 的具体操作。

选择已提交新记录。

状态切换按钮用于确定 webhook 在保存时是否处于活动状态。

保留其设置为打开（默认值）。
单击保存。

Webhook 随即可供使用，且在每次提交调查响应时都会运行。在 webhook 提供程序中设置的规则可以确保仅在满足某些条件时才发送电子邮件。

事件负载属性

Webhook 事件将属性负载作为 JSON 对象发送。负载的内容将根据所使用的 webhook 类型和调查而有所不同。

要素图层 webhook 仅包含 addData 或 editData 事件。有关详细信息，请参阅要素图层 webhook 负载。

Survey123 webhook 包含事件类型和其他属性。下表列出了 Survey123 webhook 的 JSON 对象中包含的常见属性：


属性	描述
eventType	事件类型。值可以为 addData 或 editData。
portalInfo	托管调查的 ArcGIS 组织的相关信息。其中包含以下属性： url token
surveyInfo	生成 webhook 的调查的相关信息。其中包含以下属性： formItemId formTitle serviceItemId serviceUrl
userInfo	提交调查的用户的 ArcGIS 组织账户信息。其中包含以下属性： username firstName lastName fullName email

Survey123 webhook 的以下属性将根据调查和事件类型而有所不同：


属性	描述
applyEdits	调查提交的应用编辑内容负载。如果 eventType 为 addData，则将包含 adds。如果 eventType 为 editData，则将包含 updates。添加新的重复记录时，还将包含 adds。
response	applyEdits 操作的响应。包括操作创建的要素的全局 ID，以及操作是否成功。
feature	提交的调查记录。其中包含以下属性： attributes geometry layerInfo result repeats 注： repeats 数组中包含的每个对象都是具有 attributes、geometry、layerInfo、result、repeats 和 attachments 的 feature。 attachments id globalId name contentType size keywords url parentObjectId

有关此主题的反馈?

警告：