问卷/评价级别的 Webhook 推送

浩客提供了推送与集成,当问卷、评价数据发生「新增」时,你可以通过 Webhook 推送到你自有的数字化系统中做后续的处理。

Webhook 推送机制

1. 所有新增数据,进行推送

  • 当有任何新增数据时,进行推送。

2. 符合条件的新增数据,进行推送

  • 当有符合条件的新增数据时,进行推送。
  • 多个条件之间关系为【且】

条件规则的设定请查数据页面的筛选规则和示例,查看数据筛选

Webhook 推送设定

除了在应用级别设置webhook,你还可以在单个问卷、评价下设置webhook。当问卷、评价数据发生「新增」时,支持将数据按照 JSON 格式发送指定服务器。

推送失败以及重连机制

  • 发送 Post 请求需要目标服务器「在 2 秒内返回 2XX(如 200)作为应答」,如果没有正确回应,尝试重新 2 次推送,间隔 2 秒。
  • 如果有连续的 5 条数据推送,都出现错误时,则停止当前的 webhook 推送。
  • 推送失败后,如需重新开启,需要在推送与集成页面重新手动保存设置,测试成功后,数据推送才会继续。

Post 数据格式

{
  "campaign": {
    // 评价/问卷详情
  },
  "entry": {
    // 数据详情
  },
  "event_type":"entry_submitted" 
}

Webhook 格式

{
    "entry":
    {
        "serial_number": 1215,
        "fields":
        {
            "field_3": "很好用,能够解决我绝大部分的问题",
            "field_4": "很好用,能够解决我绝大部分的问题",
            "field_1": 10,
            "field_2": "很好用,能够解决我绝大部分的问题",
            "field_5": "null"
        },
        "customer":
        {
            "uid": "00000001",
            "name": "howxm",
            "email": "demo@howxm.com",
            "mobile": "15380000000"
        },
        "created_at": "2022-12-15T10:00:00Z",
        "ip": "113.200.81.42",
        "platform": "Mac",
        "os": "Mac OS X 10.15.7",
        "browser": "Chrome 109.0.0",
        "region":
        {
            "country": "中国",
            "province": "陕西省",
            "city": "西安市"
        },
        "filling_duration": 123,
        "referer": "https://howxm.com/",
        "triggerred_by_event": "payment_clicked",
        "delivery_method": "SDK",
        "system_link": "https://app.howxm.com/apps/89f925605c2f66096df997367878e3a5/surveys/5c2812607d60291ab1e00b256d0b5fc0/entries/1215",
        "submitted_on": "completion"
    },
    "campaign":
    {
        "id": "5c2812607d60291ab1e00b256d0b5fc0",
        "name": "NPS 净推荐值调研",
        "fields":
        [
            {
                "label": "您是否愿意把我们推荐给身边的人?",
                "code": "field_1",
                "type": "NpsField"
            },
            {
                "label": "很遗憾没能让您满意,我们应该如何改善产品体验?",
                "code": "field_2",
                "type": "TextArea"
            },
            {
                "label": "感谢您的评分,我们怎样才能做得更好?",
                "code": "field_3",
                "type": "TextArea"
            },
            {
                "label": "感谢您的评分,您最喜欢我们产品的哪里?",
                "code": "field_4",
                "type": "TextArea"
            },
            {
                "label": "感谢您的反馈️",
                "code": "field_5",
                "type": "EndingField"
            }
        ]
    },
    "event_type": "entry_submitted"
}   

字段对照表

  • 问卷/评价题目字段类型:NPS、CSAT、CES、评分、多选题、单选题、简答题、CTA

  • 系统字段:填写时长、填写地区、浏览器、操作系统、IP、提交方式、填写页面

  • 客户属性:预设客户属性、传入客户属性

字段code 字段说明 备注
campaign[].id 问卷/评价ID
campaign[].name 问卷/评价名称
campaign[].fields 问卷/评价题目类型
entry[].serial_number 数据序号
entry[].fields 题目数据详情
entry[].customer 客户信息
entry[].ip IP
entry[].os 操作系统
entry[].browser 浏览器
entry[].region 填写地区
entry[].filling_duration 填写时长
entry[].referer 填写页面
entry[].triggerred_by_event 问卷/评价触发事件
entry[].delivery_method 投放方式
entry[].system_link 数据分享链接
entry[].submitted_on 提交方式

自定义字段API Code

为了方便在多个 campaign 之间存储相同类型的业务数据,浩客支持自定义问卷/评价的 API Code