使用 Webhook 连接器

使用 Studio 中的 HTTP Webhook 连接器

1. 选择 HTTP Webhook 触发器

   在 Studio 中，选择“HTTP Webhook”触发器。

2. 创建或选择连接

   使用现有连接或创建新连接。

3. 复制 Webhook URL

   从触发器活动中检索生成的 Webhook URL。

4. 配置数据筛选器

   定义应触发 Webhook 事件的条件。

5. Publish your process

   发布工作流，以便触发工作流。

6. 在应用程序中注册 Webhook URL

   将第 3 步中复制的 Webhook URL 粘贴到供应商应用程序的 Webhook 配置中。

在 Orchestrator 中使用 HTTP Webhook 连接器

1. 在 Orchestrator 中，选择“打开事件触发器” > “添加新触发器” 。

2. 选择您的流程，提供名称，然后单击“下一步” 。

3. 选择“连接器”：HTTP Webhook 。

4. 创建或选择连接。

   使用现有连接或创建新连接。了解如何创建连接。

5. 配置数据筛选器。

   定义应触发 Webhook 事件的条件。了解如何配置数据筛选器。

6. 复制 Webhook URL 以备后用。

7. 添加触发器以完成设置。

8. 在工作流中，使用获取触发器事件输出活动，来利用 Webhook 的标头或正文。

   传递UiPathEventObjectId （数据类型=文本）作为必需属性“UiPath 事件对象 ID”的输入参数。

创建 HTTP Webhook 连接

1. 为连接命名
   在“此 Webhook 适用的应用程序”字段中，输入 Webhook 应用程序的描述性名称，您可以轻松识别此连接所代表的供应商或集成。此值将成为连接标识符。
2. 配置质询位置
   选择供应商发送质询令牌的方式，以便 UiPath 可以正确响应，或选择“无质询” 。常见选项：
   • 查询参数（例如?challenge=... ）
   • JSON 正文（带有{ "challenge": "..." } POST）
   • 标头（例如X-Hub-Challenge ）
3. 配置质询验证并连接
   如果供应商需要握手，请输入与供应商模式匹配的质询配置（要读取哪个字段/标头/查询以及如何回显/验证）。配置完成后，单击“连接” 。了解有关质询验证的更多信息。

提示：

• 使用包含供应商和环境的名称（例如 Stripe-prod 或 Slack-staging）以避免混淆。
• 如果您不确定供应商使用哪种质询模式，请查看其 Webhook 文档或运行测试注册以检查握手请求。

Webhook 质询验证

一些供应商要求在开始发送实际事件之前验证 Webhook URL。这是通过使用质询-响应机制来完成的。在注册 Webhook 时，供应商会发送特殊质询请求，并且端点必须完全按预期响应。

HTTP Webhook 连接器通过Webhook 挑战框架支持这些验证流程，从而允许您配置 UiPath 读取和响应供应商挑战的方式。

质询验证支持

UiPath 支持两种类型的供应商 Webhook 行为：

• 不使用质询验证的供应商
• 在激活 Webhook 之前需要质询握手的供应商

这可确保与简单以及具有更高级安全要求的提供程序兼容。

当供应商不使用质询验证时

许多应用程序只是接受 Webhook URL 并立即开始传递事件。
对于这些供应商：

• 用户只需创建或选择一个连接。
• 复制Webhook URL（URL） 。
• 将其粘贴到供应商的 Webhook 配置中。

不需要其他步骤。一旦供应商开始发送事件，Webhook 将变为活动状态。

这是最常见也是最简单的场景，UiPath 可以无缝处理。

每当供应商确实要求质询验证时，

一些供应商在启用 Webhook URL 之前会发送质询请求以验证该 URL。
在这些情况下：

• 用户必须在 HTTP Webhook 连接中配置质询响应。
• UiPath 侦听供应商的质询请求。
• UiPath 根据配置自动返回正确的质询值。
• 供应商验证了响应后，普通事件将开始流动。

由于供应商发送质询的方式（查询参数、JSON 正文、标头等）各不相同，UiPath 的配置允许用户处理其中的任何模式。

这可确保与强制执行安全握手的 Webhook 提供程序兼容，例如 Slack、Meta ( Facebook/Instagram)、S Stripe 等。

配置质询验证

您可以使用四个参数配置质询行为：

• 挑战密钥
  包含质询值的字段/键。用于检测质询请求（不得为 null）。

• 挑战地点
  其中键出现的位置：

  • 正文
  • 查询参数
  • 页眉

• 质询响应内容类型
  返回给供应商的响应格式：

  • 文本/纯文本
  • application/json

• 质询响应格式
  定义返回的值（通常是质询密钥本身）。
  UiPath 从传入的质询中提取值，并做出相应的响应。

通用示例

传入的请求

 {
  "challenge": "ABC123"
 }

配置

• 挑战密钥： challenge != null
• 挑战位置：正文
• 响应类型： text/plain
• 响应格式： challenge

响应

ABC123

WhatsApp 质询验证示例

WhatsApp 将基于查询参数的质询方法与Hub.challenge结合使用。

配置

参数	值
挑战密钥	hub.challenge != null
挑战地点	查询参数
质询响应内容类型	text/plain
质询响应格式	hub.challenge

供应商请求

GET https://your-webhook-url?hub.challenge=1234567890

预期 UiPath 响应

HTTP/1.1 200 OK
Content-Type: text/plain

1234567890

这将确认所有权，然后 WhatsApp 开始发送实际的 Webhook 事件。

摘要 — 通用与 WhatsApp

步骤	一般示例	WhatsApp 示例
挑战地点	正文/查询/标头	查询
密钥格式	简单键（例如challenge ）	带有点（“ hub.challenge ”）的密钥
响应类型	text/纯文本 或 application/json	文本/纯文本
响应值	键的值	“ hub.challenge ”的值
方法	POST 或 GET	仅获取

配置数据筛选器

数据筛选器可以应用于提供程序响应的正文和标头。

假设提供程序返回的正文响应如下：

{
  "id": "exampleCartId",
  "token": "exampleCartId",
  "email":"[e-mail]"
  }

Orchestrator 事件触发器

如果要在令牌包含exampleCartId时触发流程，可以按照以下方法设置：

备注：

当 JSON 属性包含连字符 ( - ) 时，必须将其用双引号括起来。
例如： header."x-shopify-shop-domain"包含ecommerce 。

Studio 事件触发器

要在 Studio 中使用“HTTP Webhook” 触发器活动完成相同的行为，请按如下方式配置筛选器：

发布

从 HTTP Webhook 事件开始发布工作流，以激活面向公众的 URL。 然后，您可以通过触发供应商应用程序中的事件或直接向 URL 发送curl命令来测试这一点：

Automation Cloud：

curl -X POST https://cloud.uipath.com/{webhook_url} -d "example 
            curl call"

Automation Cloud 公共部门：

curl -X POST https://govcloud.uipath.us/{webhook_url} -d "example
            curl call"

当 Integration Service 接受事件时，它会使用以下 JSON 有效负载进行响应：

{ "webhookEventId": "wr-4ad55717e1.a7bbf1e8-72a1-4371-82d2-d{example}", "correlationId": "384d496c-2f6d-{example}" }

备注：

此有效负载可用于测试，但在工作流的任何位置都不是必需的。