开发指南
推送方式
订阅的事件发生时，将会通过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天。
私有云 保存时间后台可配置。