关于 HTTP Webhook 连接器

在 Integration Service 中配置 HTTP Webhook 连接器，以从外部应用程序接收事件驱动的实时回调，而无需轮询。

Webhook 让应用程序能够实时通知外部系统，从而减少频繁轮询的需求，并最大限度地减少 API 调用。系统不会定期检查更新，而是仅在发生相关更改时才会收到基于事件的回调。

UiPath HTTP Webhook 连接器允许您直接从供应商应用程序触发工作流。您可以为支持出站 Webhook 通知的任何第三方应用程序创建即时事件触发器，即使该应用程序不是连接器目录的一部分也是如此。

您还可以应用事件数据筛选器，以指定 Webhook 事件应触发工作流的确切条件。

工作方式

HTTP Webhook触发器会生成动态公共回调 URL。仅在在 Orchestrator 中创建了触发器之后，才能在供应商应用程序的 Webhook 设置中复制并配置此 URL。

当供应商系统中发生事件时：

1. 供应商将事件有效负载发送到配置的 URL。
2. Integration Service 接收有效负载，并根据您配置的事件数据筛选器对其进行评估。
3. 如果找到匹配项，Integration Service 将通过 Orchestrator 触发工作流执行。

Webhook 有效负载的处理方式与处理其他任何触发器事件的方式相同。连接器还支持可选的基于标头的身份验证，使供应商在每次交付 Webhook 时使用配置的标头值向 UiPath 验证自身身份。

有关更多信息，请参阅“使用 Webhook 连接器” 。

有关如何创建连接和配置质询验证的信息，如果供应商要求，请参阅“HTTP Webhook 身份验证” 。

安全性

HTTP Webhook 连接器提供两种补充的安全机制，均在创建连接时进行配置：

机制	操作	何时使用
质询验证	让供应商在发送事件之前确认您的 UiPath Webhook URL 有效。	当供应商需要握手时（Slack、Meta 等）。
基于标头的身份验证	使用 HTTP 标头中包含的共享密码（例如X-API-Key ）验证每个传入的 Webhook 请求。未包含配置的标头值的请求将被拒绝，显示为 HTTP 401。	当您要防止未经授权的调用者发布到您的 Webhook URL，并且您的供应商允许您在出站 Webhook 交付上配置自定义标头时。

有关设置的详细信息，请参阅HTTP Webhook 身份验证。

速率限制

Webhook 触发的事件受到以下限制的约束：

• 每个租户每分钟 500 个事件
• 每个连接每分钟处理 100 个事件

限制

• 当前不提供设计时触发器调试。
• 仅支持 JSON 格式的请求。
• 支持的 Webhook 有效负载大小上限为 14 MB。超过此限制的请求将被拒绝，并且不会调度任何触发器事件。

常见问题

我已将 Webhook URL 粘贴到提供程序的用户界面中，为什么验证仍然未通过？

只有在 Orchestrator 中创建触发器并正确配置质询后，验证才会成功。请注意，UiPath 不会在我们这边执行任何质询验证，验证完全在提供程序端进行，以便与目标建立信任。

我错误地配置了质询，为何仍能成功创建连接？

UiPath 当前不会验证提供程序的质询/验证步骤。此验证完全由供应商处理。因此，即使提供程序的质询验证在它们端实际上已失败，UiPath 中的连接也可能会显示为活动连接。

如何使用来自在 Orchestrator 中创建的 Webhook 的响应?

在工作流中使用“获取触发器事件输出”活动，并传递“UiPath 事件对象 ID” （数据类型=“文本”）作为输入参数。此活动将返回从 Webhook 收到的正文和标头。

Webhook 响应是 JSON 字符串。如何在我的工作流中使用它的各个部分？

使用“反序列化 JSON”活动将字符串转换为 JObject，之后即可轻松访问各个字段。

在将 Webhook 事件发送到 UiPath 时，是否可以要求供应商进行身份验证？

是的。在创建或编辑连接时启用基于标头的身份验证，然后在供应商的 Webhook 设置中配置匹配的标头。有关设置说明，请参阅HTTP Webhook 身份验证。

我的供应商使用自己的签名方案（例如X-Hub-Signature-256 ）。我是否仍可以使用基于标头的身份验证？

否。基于标头的身份验证使用静态的预共享标头值。基于签名的供应商使用有效负载和共享密钥对每个请求计算新的 HMAC——UiPath 目前不会验证供应商专属签名。对于这些供应商，可用的安全机制包括 URL 加密和供应商的质询验证握手。