系统webhook
功能说明
在系统中新建应用和新建表单时,将操作与变更后的数据推送至目标服务器。
系统webhook管理
新建
新建系统webhook推送。
设置内容:
- 【服务器地址】:接收推送数据的地址,一般是http:// ,https:// 开头的网址;可以设置自有服务器。
- 【服务器链接测试】:填写好服务器地址后,可以对服务器进行连接测试。
- 【Secret】:支持手动输入一串字符当做加密EncryptKey。数据推送会把通过secret加密后的内容一起推送到目标服务器地址。具体的加密解密方式参考加密方式及解密算法。
- 【生成Secret】:自动生成加密EncryptKey。
- 【推送事件】:自定义勾选需要推送数据的事件,不勾选则不推送该事件。至少要勾选其中一项具体。推送事件及场景见下面章节:[推送事件]
相关规则:
- 【服务器地址】【推送事件】必填,【Secret】可不填
- 服务器地址必须是以http:// https:// 开头的网址
编辑
编辑已存在数据推送,【服务器地址】、【Secret】、【推送事件】可编辑。
删除
删除已存在的数据推送设置,删除后不再进行数据推送。
启用&停用
启用状态的数据推送才会进行推送,停用状态的数据推送不会推送。
注意:
- 当数据推送连续推送失败超过10次,此数据推送设置就会自动停用;
- 停用的数据重新启用后,重新计算推送失败次数,即再连续推送失败超过10此会停用;
- 私有云,失败次数(10次)可在后台配置;
推送日志
推送日志中记录了近30天内的数据,支持根据推送失败日志、推送成功日志、待发送日志、放弃推送日志、全部日志去筛选查询推送记录;
注意:私有云,日志保存天数后台可配置。
推送日志里记录了每条推送记录的时间、地址、事件、结果、推送详情。
- 推送详情中可以查看到推送内容、状态码、推送时间、错误详情等信息,如果事件推送错误了还以在此处查看到具体信息。
推送事件
通过各种方式创建应用或者表单时均会触发webhook推送。
推送事件详情
创建应用 | ||
---|---|---|
推送事件名称 | eventType | 触发场景 |
新建应用时推送 | app_create | 场景1:创建应用-创建空白应用 场景2:创建应用-导入安装包 场景3:创建应用-安装应用模板 场景4:通过别人的应用分享链接安装应用 场景5:复制应用 |
创建表单 | ||
---|---|---|
推送事件名称 | eventType | 触发场景 |
新建表单时推送 | form_create | 场景1:创建应用的同时创建了表单 场景2:新建表单:创建空白表单、从Excel创建表单 场景3:新建报表 场景4:复制表单/报表 |
推送数据结构
参数 | 说明 |
---|---|
eventType | 推送事件,可参考上面【推送事件详情】 |
eventData | 具体推送内容 |
time | 推送时间 |
eventId | 推送数据ID |
示例:新建应用时推送数据
{"eventType":"app_create","eventData":{"appId":"58d21d96c837b99e8bc450a0"},"time":1692863190150,"eventId":"1692863190150eumztt"}