Bugly Webhook 接入指南

一、接入说明

在每个产品的「产品配置」下的「Webhook」中,可以配置你要接收崩溃消息的 Webhook 地址。 配置成功后当相应的条件满足时,我们将 POST 相应的信息到你设置的 Webhook 地址上 。Bugly当前支持第三方与自定义两种方式。

二、第三方接入

BearyChat 接入

在Bugly中设置 BearyChat 的 WebHook 地址,填写时需要先获取 BearyChat的 Hook 地址,获取方法如下:

第一步:在 BearyChat的团队设置中选择「机器人管理」

Alt text

第二步:在机器人中选择 Bugly

Alt text

第三步:选择要接受消息的讨论组

Alt text

第四步:获取到 Hook 地址,复制 Hook 地址到 Bugly 的产品配置配置 WebHook 地址

步骤1 进入Bugly的「产品设置」模块 进入产品列表页,选择需要配置的产品,点击「设置」

Alt text

步骤2 进入产品设置的「Webhook」模块

Alt text

步骤3 设置Webhook

选择「Bearychat」标签并点击「添加」,将 https://hook.bearychat.com/=XXX 填入 「URL」 中,选择希望要推送的功能,并创建。

Alt text

步骤4 设置完成 搞定后,就可以在BearyChat中收到来自「Bugly机器人」的提醒了!

Alt text

Worktile 接入

在填写Hook地址前,需要先在Worktile中获取地址,获取方法如下:

第一步,先在企业后台左侧找到服务管理,选中并添加Bugly服务,指定消息群组;

Alt text

第二步,按照配置说明在Bugly配置即可

步骤1 进入Bugly的「产品设置」模块 进入产品列表页,选择需要配置的产品,点击「设置」

Alt text

步骤2 进入产品设置的「Webhook」模块

Alt text

步骤3 设置Webhook

选择「Worktile」标签并点击「添加」,将 https://hook.worktile.com/XXX 填入 「URL」 中,选择希望要推送的功能,并创建。

Alt text

步骤4 设置完成 搞定后,就可以在Worktile中收到来自「Bugly机器人」的提醒了!

Alt text

三、自定义接入

在自定义的Webhook栏输入自己的地址,可以选择自己关注的事件类型,当这些事件发生时,Bugly会主动回调配置的地址,相关的事件类型及协议字段说明如下:

事件类型: App纬度: (1)每日Crash统计(联网数/崩溃率) (2)TAG Crash数据

参数说明: 回调时,向注册时的callbackurl(回调地址)POST数据事件,事件内容以JSON格式组织,基本信息包括: (1)eventContent:事件内容 (2)eventType:事件类型

每日Crash统计示例 (崩溃率由业务自己决定用哪些参数计算)

{
  "eventType": "bugly_crash_trend",
  "timestamp": 1462780713515,
  "isEncrypt": 0,
  "eventContent": {
    "datas": [
      {
        "accessUser": 12972,//联网用户数
        "crashCount": 21,//crash次数
        "crashUser": 20,//crash影响用户数
        "version": "1.2.3",//app版本号
        "url": "http://bugly.qq.com/realtime?app=1104512706&pid=1&ptag=1005-10003&vers=0.0.0.12.12&time=last_7_day&tab=crash"
      },
      {
        "accessUser": 15019,
        "crashCount": 66,
        "crashUser": 64,
        "version": "1.2.4",
        "url": "http://bugly.qq.com/realtime?app=1104512706&pid=1&ptag=1005-10003&vers=0.0.0.12.12&time=last_7_day&tab=crash"
      },
      {
        "accessUser": 15120,
        "crashCount": 1430,
        "crashUser": 1423,
        "version": "1.2.4",
        "url": "http://bugly.qq.com/realtime?app=1104512706&pid=1&ptag=1005-10003&vers=0.0.0.12.12&time=last_7_day&tab=crash"
      }
    ],
    "appId": "1104512706", //appId
    "platformId": 1   //平台
"appName": "AF", //app名称
    "date": "20160508",
"appUrl":"http://bugly.qq.com/issueIndex?app=1104512706&pid=1&ptag=1005-10000" 
  },
  "signature": "ACE346A4AE13A23A52A0D0D19350B466AF51728A"
}

TAG Crash统计示例(崩溃率由业务自己决定用哪些参数计算)

{
  "eventType": "bugly_tag",
  "timestamp": 1462780713515,
  "isEncrypt": 0,
  "eventContent": {
    "datas": [
      {
        "tagId": 12972, //tagId
        "tagName": "testTag2", //tag名称
        "crashCount": 21,//crash次数
        "crashUser": 20,//crash用户数
        "type": 2     //tag类型,1为sdk上设置上报,2为页面手动设置
        "url": "http://bugly.qq.com/search?app=1104512706&pid=1&ptag=1017-10000&ver=all&bi=all&cl=all&ct=all&s=all&dt=all&tl=12972"
      },
      {
        "tagId": 15019,
        "tagName": "testTag1",
        "crashCount": 66,
        "crashUser": 64,
        "type": 2
        "url": "http://bugly.qq.com/search?app=1104512706&pid=1&ptag=1017-10000&ver=all&bi=all&cl=all&ct=all&s=all&dt=all&tl=12972"
      },
      {
        "tagId": 15120,
        "tagName": "testTag",
        "crashCount": 1430,
        "crashUser": 1423,
        "type": 2
        "url": "http://bugly.qq.com/search?app=1104512706&pid=1&ptag=1017-10000&ver=all&bi=all&cl=all&ct=all&s=all&dt=all&tl=12972"
      }
    ],
    "appId": "1104512706",
    "platformId": 1
    "appName": "AF", //app名称
    "date": "20160508",
    "appUrl":"http://bugly.qq.com/issueIndex?app=1104512706&pid=1&ptag=1005-10000"  
  },
  "signature": "ACE346A4AE13A23A52A0D0D19350B466AF51728A"
}