跳到主要内容

工作流触发方式--Webhook触发

功能介绍​

Webhook 是为外部应用提供的向本应用传递实时信息的一种方式。

外部应用通过Webhook发送HTTPS请求，当Webhook服务器收到请求时，会自动触发工作流，在工作流中进行数据新增或更新，实现和其他系统的数据对接。简单一句话：通过Webhook触发的工作流，可以实现从其他应用或服务自动接收数据。

如何接收数据/触发流程​

每个Webhook触发的流程都会自动生成一个唯一的URL地址，外部应用只需将此地址添加到回调地址中（推送地址），即可将数据自动推送过来。

每当此Wehook URL地址收到数据后即可自动解析数据中的字段，并自动触发流程。

解析生成样本数据​

在第一次配置时，需要先建立数据样本，后面推送进来的数据就可以根据数据样本在工作流中使用了。

解析的数据支持将参数设为必填项，此时如果对方的请求中没有附带该参数时，我们将返回错误消息"msg": "参数缺少必填项"。

从请求范例生成​

选择此方式后，需要在3分钟内向URL发送一条GET或POST请求，推送过来数据。接收到数据后，会自动解析。

下面是接收到数据后，自动解析了数据。

生成Body全文参数

勾选后，会同时将Body全文内容作为一个参数。

从JSON数据范例生成​

根据准备好的JSON格式的数据解析数据

从key-value pairs生成​

使用数据​

确定好样本数据后，后续节点即可使用传递进来的数据。

响应方式​

外部应用在向Webhook发起请求后，在工作流配置-平台API能力页面中，可以自定义响应方式及返回内容。

安全​

默认情况下，只要获取到webhook URL即可请求，可以通过应用授权和IP白名单两种方式，提高安全性。

  • 请求鉴权认证

    开启使用应用授权后，请求参数需包含 AppKey、Sign。

  • 使用应用IP白名单

    仅在白名单中的IP才能发送请求

TIPS​

在Webhook触发流程的列表中，可以通过搜索 webhook的URL中生成的ID快速搜索到工作流

文档问题反馈

文档中是否有错别字、内容过期、难以理解等问题？ 点此给我们反馈吧