宜点云宜点课堂
  • 首页
  • 帮助文档
  • 后端python
  • 开放平台
  • 私有云
  • 场景案例
  • 更新日志
返回控制台
返回控制台
  • 首页
  • 功能插件
  • 密钥管理
  • 单点登录
    • 开发指南
    • SAML2.0配置
    • 自定义接口配置
  • Webhook
    • webhook开发指南
    • 表单webhook
    • 通讯录webhook
    • 系统webhook
    • 加密方式及解密算法
  • API
    • 开发指南
    • 数据筛选器
    • 错误对照表
    • 字段与数据类型对照表
    • POST接口
    • 应用体系-表单管理
      • 查询表单字段结构
      • 获取表单基本信息
      • 查询表单计划任务列表
      • 执行计划任务
      • 开启停用计划任务
      • 查询成员控件配置信息
      • 查询部门控件配置信息
      • 修改成员控件
      • 修改部门控件
      • 查询流程节点配置信息
      • 修改流程节点配置
    • 应用体系-表单数据
      • 新增数据
      • 查询单条数据
      • 查询多条数据
      • 编辑数据
      • 删除数据
      • 批量新增数据
      • 查询数据总数
      • 批量修改数据
      • 批量删除数据
      • 新增唯一数据
      • 新增多条唯一数据
      • 文件上传
    • 应用体系-表单流程
      • 发起流程
      • 结束流程
      • 流程修改
      • 流程催办
      • 批量结束流程
      • 获取流程操作日志
      • 查询流程信息
      • 查询流程待办信息
      • 查询流程待办数量
    • 应用体系-数据视图
      • 查询数据视图输出表字段
      • 查询数据视图数据
      • 查询数据视图数据总数
      • 数据视图修改
    • 应用体系-聚合表
      • 查询聚合表输出字段
      • 查询聚合表数据
      • 查询聚合表数据总数
      • 聚合表修改
    • 通讯录体系-成员
      • 获取成员详细信息
      • 修改成员信息
      • 员工离职
      • 员工离职恢复
      • 删除成员
      • 指定部门下添加一位成员
      • 查询成员列表
      • 成员转外部联系人
      • 修改成员职位
    • 通讯录体系-部门
      • 创建部门
      • 修改部门名称
      • 修改父级部门
      • 查询指定部门下的所有子部门信息
      • 查询部门信息
      • 删除部门
      • 获取部门成员
    • 通讯录体系-职位
      • 获取职位列表
      • 添加职位
      • 修改职位
      • 删除职位
    • 通讯录体系-角色
      • 新建角色或角色组
      • 修改角色或角色组
      • 获取角色组信息
      • 获取角色组列表
      • 删除角色组
      • 获取角色组成员列表
      • 批量创建角色
      • 批量创建角色组
      • 批量删除角色组
      • 角色组添加成员
      • 删除角色组成员
    • 通讯录体系-外部联系人分组
      • 获取外部联系人分组列表
      • 获取外部联系人分组成员列表
      • 获取外部联系人分组信息
      • 新建外部联系人分组
      • 修改外部联系人分组名称
      • 删除外部联系人分组
      • 批量删除外部联系人分组
      • 批量新增外部联系人分组
    • 通讯录体系-外部联系人管理
      • 获取外部联系人成员信息
      • 修改外部联系人成员信息
      • 外部联系人删除
      • 外部联系人成员删除恢复
      • 外部联系人转成员
    • 通讯录体系-管理组
      • 新建管理组
      • 查询管理组列表
      • 查询管理组详情
      • 删除管理组
      • 修改普通管理组详情
      • 修改系统管理组管理员
    • 通讯录体系-互联组织
      • 列出我连接的企业
      • 列出我连接的企业的对接人
      • 获取我连接的企业对接人的详细信息
      • 查询互联企业角色列表
      • 查询互联企业对接部门列表
      • 查询互联企业对接部门的成员
    • 平台体系-账号
      • 注册账号
      • 加入某个团队
      • 加入某个团队的外部联系人
      • 账号绑定微信
      • 账号解绑微信
      • 查询账号基本信息
      • 修改账号信息
      • 登录账号
      • 查询账号列表
      • 修改团队信息
    • 平台体系-消息
      • 发送邮件消息
      • 发送钉钉消息
      • 发送飞书消息
      • 发送微信消息
      • 发送企业微信消息
    • 平台体系-应用管理
      • 创建应用分组
      • 查询应用分组列表
      • 应用分组重命名
      • 应用分组删除
      • 查询应用列表
      • 获取应用的表单列表
      • 查询应用下的待办数量
      • 获取数据视图列表
      • 查询聚合表列表
      • 打印模板打印数据
      • 打印模板批量打印数据
      • 查询打印模板列表
      • 自定义数据打印
      • 自定义数据批量打印
      • 查询报表控件
      • 查询表单权限组列表
      • 创建表单自定义权限组
      • 修改表单权限组信息
      • 批量修改表单权限组
      • 删除表单自定义权限组
    • 平台体系-密钥管理
      • 创建秘钥
      • 查询密钥
      • 删除秘钥
    • 平台体系-性能配置
      • 查询用户基础配置信息
      • 查询用户汇总配置信息
      • 修改用户基础配置信息
      • 为用户赠送指定配置
      • 查询配置赠送列表
      • 查询配置消耗
      • 查询已购买套餐列表
    • 平台体系-设置
      • 查询模板应用总数
      • 查询模板应用列表
      • 安装模板应用
      • 查询站点公告
      • 修改站点公告
      • 查询微信access_token
    • 平台体系-日志查询
      • 查询登录日志
      • 查询日志类型
      • 查询平台操作日志
      • 查询应用日志
    • 平台体系-webhook管理
      • 查询webhook列表
      • 新建webhook
      • 修改webhook
      • 删除webhook

系统webhook

  • 功能说明
  • 系统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"}
最新修改于:2023-08-24