更新日期

1. 简介

1.1 功能概述

Webhook 是外部系统向本应用发送实时事件通知的标准化机制。可以通俗地理解为一种“反向API”,当外部事件发生时,外部系统主动推送数据给你,系统不需要不停地去询问外部系统“有没有新消息”。
外部应用通过Webhook URL发送HTTPS请求,当Webhook服务器收到请求时,会自动触发工作流,在工作流中进行数据新增或更新等操作,实现和其他系统的数据对接

1.2 应用场景

  • 同步订单状态:客户支付成功时,更新订单状态并通知相关人员。
  • 自动新增意向客户信息:用户在官网填写了“申请试用”,自动在系统中新增意向客户信息。
  • 自动同步快递信息:快递公司接口向商家系统发送 Webhook,自动设置订单状态为“已揽件”。

2. 功能说明

2.1 创建工作流

在应用后台工作流管理页中,点击右上方「+ 工作流」按钮新建工作流,在弹窗中选择“Webhook触发”,点击“确定”进入下一步。

2.2 设置触发节点

进入工作流设计页面后,点击Webhook节点即可唤起配置窗口,对触发节点进行设置。
2.2.1 Webhook URL
在节点配置窗口中可以看到生成的Webhook URL。Webhook URL 是专门用于接收来自外部应用的实时通知和数据的回调地址。将此地址配置到外部应用中,当此 URL 接收到数据后即可自动解析数据中的字段,并触发流程。
2.2.2 设置请求数据JSON格式
用户需要提供一份 JSON 数据范例,系统将据此解析数据结构,以便后续流程对该参数字段的使用。点击下一步可以查看解析 JSON范例得到的参数列表。
点击“编辑”可以再次更改JSON格式的请求数据。

3. 使用示例

配置完Webhook节点后,即可在工作流的后续节点中调用传入的数据。
以下以场景“在企业开发的小程序中使用页面接收用户反馈并同步回英雄云中”为例,演示如何将 Webhook 数据写入指定表单并完成字段映射。
配置步骤:
  1)创建webhook工作流并设置如 2.2.2节中的请求数据格式。
  2)添加“新增数据”节点,选择新增方式和新增数据条数。
  3)设置字段:选择表单字段,设置字段值为对应的 Webhook 数据字段。
外部应用通过调用Webhook URL来发送HTTPS请求。例如,在小程序中,用户填写反馈页面后,点击提交按钮触发以下方法。该方法使用 wx.request 调用Webhook URL发送HTTPS请求。英雄云系统收到回调信息后,即可新增一条表单数据。
效果演示: