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

开发指南

  • 推送方式
  • 推送内容
  • 接受响应
  • 结果处理
  • 错误处理
  • 数据安全
  • 日志

推送方式

订阅的事件发生时,将会通过HTTP POST请求发送Json格式的事件数据到预先配置的服务器网址URL。

POST http://example.com/aaa/hook
{"eventType":"data_create.web.one.flow.forward","eventData":{"fieldsData":{"_widget_1634031019073":"出差报销"},"_id":"53f681acc94ada0fcb44105c","createTime":"2021-11-18 15:05:54","creator":{"name":"张三","_id":"5ac5d84afd869465cce6745b"},"chargers":[{"name":"19174ding","_id":"5034260c577cc5d345460412@1","status":2},{"name":"19174866220","_id":"5444e588b0cde5af638bd936@1","status":2}],"node":{"name":"经理审批","_id":1},"flowDecision":{"state_id":"0","state":""},"flowState":"0","form":{"appId":"54addef19b72c4ccddc53265","formId":"5c49f988edf22bc04b639e37"}},"time":1637219154369,"eventId":"1637219154369yl8i7n"}

推送内容

推送数据结构

参数 说明
eventType 推送事件
eventData 具体推送内容
time 推送时间
eventId 推送数据ID

推送内容示例:

  • 流程表单新增流程的数据推送

    {"eventType":"data_create.web.one.flow.forward","eventData":{"fieldsData":{"_widget_1634031019073":"出差报销"},"_id":"53f681acc94ada0fcb44105c","createTime":"2021-11-18 15:05:54","creator":{"name":"张三","_id":"5ac5d84afd869465cce6745b"},"chargers":[{"name":"19174ding","_id":"5034260c577cc5d345460412@1","status":2},{"name":"19174866220","_id":"5444e588b0cde5af638bd936@1","status":2}],"node":{"name":"经理审批","_id":1},"flowDecision":{"state_id":"0","state":""},"flowState":"0","form":{"appId":"54addef19b72c4ccddc53265","formId":"5c49f988edf22bc04b639e37"}},"time":1637219154369,"eventId":"1637219154369yl8i7n"}
  • 新增通讯录成员的推送数据

    {"eventType":"user_create.web","eventData":{"idList":["5466ebe918a90c64c26fcc67"]},"time":1637307235940,"eventId":"16373072359405rfuhm"}

接受响应

百数对应目标服务器推送请求,该服务器收到此请求后,需要在2秒内以HTTP 200状态码 响应该请求,即认为数据推送成功。

其他的返回结果则为返回信息错误,用户可以根据HTTP状态码自行定义推送错误的情况给百数的返回码,百数接受后,可在推送日志中显示出。

结果处理

所有推送的详情可在日志中查询。

错误处理

  • 一次推送重试最多5次,如果单次推送连续重试5次均失败,则该次推送失败,此时会记录该数据在失败记录里。

  • 同一数据推送,推送失败10次,该推送功能将被关闭,管理会获得消息通知(站内信息),则需要管理员在推送设置中重新启动推送。

    私有云 重试次数和失败次数 后台可配置。

数据安全

设置Encrypt Key来进行数据数据加解密和验证来源。 加密方式及解密算法代码 见加密方式及解密算法。

日志

所有日志均会保存,并且可查询。日志到期会清空,保存时间30天。

私有云 保存时间后台可配置。

最新修改于:2022-02-17