跳到主要内容

Webhook

功能简介

webhook是轻流应用中,流程上的一个节点(如下图)。在这个节点,您可以通过简单的配置,当数据流经该节点时,自动触发并使用您所需的第三方系统API提供的功能,如向钉钉系统增加新成员,调用谷歌日历,发送邮件,Trello增加卡片,github增加Issue等等。您也可以基于轻流进行二次开发,与公司已有的系统进行对接。

Webhook也支持全局配置,在轻商城-插件中心-第三方连接-webhook配置界面进行配置后保存,即可以配置并生成全局可用的Webhook模版,方便您的后续使用。

目前webhook功能仅对企业版用户开放,如需试用或升级,请联系与您对接的轻流同事。

文档图片

设置步骤

(1) 请先确认您的版本:Webhook 为一种Q-Robot节点,目前仅开放给企业版及以上用户,如需试用或升级,请联系我们(具体见本文底端)。

(2) 在轻商城-插件中心-第三方连接中安装Webhook功能

文档图片

(3) 编辑应用流程时,添加Webhook节点,点击后可以看到以下配置内容

文档图片 文档图片

(4) 各个配置项说明

配置项名称可填内容用途描述
配置模式自定义/使用插件中心模版/使用连接中心模版如果想使用已有的webhook全局配置或连接中心现有的模版,可以选择对应模版直接使用,免去配置过程
鉴权方式插件中心已有的鉴权可以使用现有鉴权,省去鉴权步骤
URL第三方系统api的url,可以插入应用中表单内的字段、「工作区ID」和「应用ID」设置为第三方系统api定义中指定的url
Method目前支持POST/PUT/DELETE/GET目前涵盖了常用的方法
触发方式默认/自定义默认情况下,会发送轻流预定义好的数据结构到指定url
Header请求发送的header信息,支持插入「工作区ID」和「应用ID」请求的header信息,支持自定义值或表单内字段插入
Bodyurl-encoded、application/json、application/xml,均支持插入「工作区ID」和「应用ID」请求的body信息,支持上述三种格式
x-www-form-urlencodedbody内容的键值对
application/jsonbody内容自定义json结构,可以插入字段这部分属于轻流webhook进阶内容,可以自定义请求体内容,支持传输普通字段、表格子字段、整表格
application/xmlbody内容自定义xml结构,可以插入字段这部分属于轻流webhook进阶内容,可以自定义请求体内容,支持传输普通字段、表格子字段、整表格
回调更新当前数据可以对返回数据进行自定义解析,更新当前表单字段支持解析XML和JSON格式的返回数据,按照自定义的规则更新到当前表单

注意事项

  • 插入字段时,实际插入的内容
插入的字段实际内容
成员字段成员绑定的邮箱
申请人申请人绑定的邮箱
上传附件附件的url
日期例:2020-09-18 14:09:46,随设置的精度变化
下拉选择、单项选择选项名称,空格隔开
  • 企业微信用户不支持插入申请人、成员与部门字段
  • 「数组格式」的结果关联到单值格式字段(如:单行文本)时,只取数组第一个对象值填入
  • 表格字段的JSON Path解析结果必须为数组
  • 超时时间为60s

视频课程

您可以点击轻流学院的教学视频来学习如何使用Webhook功能。

SP3 Webhook配置详解