传出webhook说明通知

最后更新时间:2021-09-28

介绍

事件内容以 JSON 格式推送到你指定的接口 URL(例如: https://xxx/api/callback ),这个地址需要 允许公网访问

info

暂时只开放部分事件推送,如需增加请联系相关负责人。(以下内容为通用格式示例,后续陆续开放Lark、DingTalk、Mattermost、WorkWechat等格式)

基本信息

基本
HTTP MethodPOST

请求头

名称类型必填描述
X-Tb-LogIdstring日志ID

示例值:"2021092309572286544XFCO1143"

Content-Typestring固定值:"application/json"

请求体

名称类型必须说明
msgstring消息
codeint状态
datemap通知详细数据
    ∟verstring版本号
    ∟eventstring事件ID
    ∟user_infomap操作人信息
        ∟idint操作人ID
        ∟namestring操作人名字
    ∟client_infomap设备信息
        ∟ipstring设备IP
        ∟tsint操作时间
        ∟uastringUser-Agent
    ∟event_detailsmap事件详情

请求体示例

json
{
"msg": "拾忆 (IT部测试专用)登录CA",
"code": "200",
"data": {
"ver": "0.1",
"event": "ca_open_report",
"user_info": {
"id": 50,
"name": "拾忆"
},
"client_info": {
"ip": "114.244.64.40",
"ts": 1632814880,
"ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A372 Safari/604.1 wechatdevtools/1.05.2105170 MicroMessenger/7.0.4 Language/zh_CN webview/"
}
"event_details": {
}
}
}