{"id":81,"type":"Article","title":"问卷/评价级别的 Webhook 推送","slug":"integration-intro","content":"浩客提供了**推送与集成**，当问卷、评价数据发生「新增」时，你可以通过 Webhook 推送到你自有的数字化系统中做后续的处理。\r\n\r\n![](https://help-assets.jinshuju.net/assets/file/1457/%E4%BC%81%E4%B8%9A%E5%BE%AE%E4%BF%A1%E6%88%AA%E5%9B%BE_95cc582d-0fc4-43a0-92eb-c41ef63810cc.png)\r\n\r\n# Webhook 推送机制\r\n\r\n## **1. 所有新增数据，进行推送**\r\n\r\n- 当有任何新增数据时，进行推送。\r\n\r\n\r\n## **2. 符合条件的新增数据，进行推送**\r\n\r\n- 当有符合条件的新增数据时，进行推送。\r\n- 多个条件之间关系为【且】\r\n\r\n条件规则的设定请查数据页面的筛选规则和示例，查看[数据筛选](https://howxm.com/help/articles/survey-data-report#5) \r\n\r\n\r\n# Webhook 推送设定\r\n除了在[应用级别设置webhook](https://howxm.com/help/articles/webhook)，你还可以在单个问卷、评价下设置webhook。当问卷、评价数据发生「新增」时，支持将数据按照 JSON 格式发送指定服务器。\r\n\r\n![](https://help-assets.jinshuju.net/assets/file/1454/%E4%BC%81%E4%B8%9A%E5%BE%AE%E4%BF%A1%E6%88%AA%E5%9B%BE_a3676bac-170c-4298-a1b9-4500a8a69f6b.png)\r\n\r\n## **推送失败以及重连机制**\r\n\r\n- 发送 Post 请求需要目标服务器「在 2 秒内返回 2XX（如 200）作为应答」，如果没有正确回应，尝试重新 2 次推送，间隔 2 秒。\r\n- 如果有连续的 5 条数据推送，都出现错误时，则停止当前的 webhook 推送。\r\n- 推送失败后，如需重新开启，需要在推送与集成页面重新手动保存设置，测试成功后，数据推送才会继续。\r\n\r\n\r\n\r\n## **Post 数据格式**\r\n```\r\n{\r\n  \"campaign\": {\r\n    // 评价/问卷详情\r\n  },\r\n  \"entry\": {\r\n    // 数据详情\r\n  },\r\n  \"event_type\":\"entry_submitted\" \r\n}\r\n```\r\n\r\n## **Webhook 格式**\r\n``` \r\n{\r\n    \"entry\":\r\n    {\r\n        \"serial_number\": 1215,\r\n        \"fields\":\r\n        {\r\n            \"field_3\": \"很好用，能够解决我绝大部分的问题\",\r\n            \"field_4\": \"很好用，能够解决我绝大部分的问题\",\r\n            \"field_1\": 10,\r\n            \"field_2\": \"很好用，能够解决我绝大部分的问题\",\r\n            \"field_5\": \"null\"\r\n        },\r\n        \"customer\":\r\n        {\r\n            \"uid\": \"00000001\",\r\n            \"name\": \"howxm\",\r\n            \"email\": \"demo@howxm.com\",\r\n            \"mobile\": \"15380000000\"\r\n        },\r\n        \"created_at\": \"2022-12-15T10:00:00Z\",\r\n        \"ip\": \"113.200.81.42\",\r\n        \"platform\": \"Mac\",\r\n        \"os\": \"Mac OS X 10.15.7\",\r\n        \"browser\": \"Chrome 109.0.0\",\r\n        \"region\":\r\n        {\r\n            \"country\": \"中国\",\r\n            \"province\": \"陕西省\",\r\n            \"city\": \"西安市\"\r\n        },\r\n        \"filling_duration\": 123,\r\n        \"referer\": \"https://howxm.com/\",\r\n        \"triggerred_by_event\": \"payment_clicked\",\r\n        \"delivery_method\": \"SDK\",\r\n        \"system_link\": \"https://app.howxm.com/apps/89f925605c2f66096df997367878e3a5/surveys/5c2812607d60291ab1e00b256d0b5fc0/entries/1215\",\r\n        \"submitted_on\": \"completion\"\r\n    },\r\n    \"campaign\":\r\n    {\r\n        \"id\": \"5c2812607d60291ab1e00b256d0b5fc0\",\r\n        \"name\": \"NPS 净推荐值调研\",\r\n        \"fields\":\r\n        [\r\n            {\r\n                \"label\": \"您是否愿意把我们推荐给身边的人？\",\r\n                \"code\": \"field_1\",\r\n                \"type\": \"NpsField\"\r\n            },\r\n            {\r\n                \"label\": \"很遗憾没能让您满意，我们应该如何改善产品体验？\",\r\n                \"code\": \"field_2\",\r\n                \"type\": \"TextArea\"\r\n            },\r\n            {\r\n                \"label\": \"感谢您的评分，我们怎样才能做得更好？\",\r\n                \"code\": \"field_3\",\r\n                \"type\": \"TextArea\"\r\n            },\r\n            {\r\n                \"label\": \"感谢您的评分，您最喜欢我们产品的哪里？\",\r\n                \"code\": \"field_4\",\r\n                \"type\": \"TextArea\"\r\n            },\r\n            {\r\n                \"label\": \"感谢您的反馈️\",\r\n                \"code\": \"field_5\",\r\n                \"type\": \"EndingField\"\r\n            }\r\n        ]\r\n    },\r\n    \"event_type\": \"entry_submitted\"\r\n}\t\r\n```\r\n\r\n## **字段对照表**\r\n\r\n- **问卷/评价题目字段类型**：NPS、CSAT、CES、评分、多选题、单选题、简答题、CTA\r\n\r\n- **系统字段**：填写时长、填写地区、浏览器、操作系统、IP、提交方式、填写页面\r\n\r\n- **客户属性**：预设客户属性、传入客户属性\r\n\r\n| 字段code\t | 字段说明\t | 备注 |\r\n| -------- | -------- | -------- |\r\n| campaign[].id     | 问卷/评价ID \t     |     |\r\n| campaign[].name     | 问卷/评价名称\t     |    |\r\n| campaign[].fields       | 问卷/评价题目类型 \t     |    |\r\n| entry[].serial_number         | 数据序号\t     |    |\r\n| entry[].fields        |  题目数据详情 \t     |   |\r\n| entry[].customer      |  客户信息\t     |    |\r\n| entry[].ip         |  IP\t     |    |\r\n| entry[].os        |  操作系统\t     |    \t|\r\n| entry[].browser   \t     |  \t 浏览器    |  \t  |\r\n| entry[].region    \t     |  \t填写地区     | \t   |\r\n| entry[].filling_duration   \t     |  \t填写时长     |   \t |\r\n| entry[].referer       |  \t  填写页面   |  \t  |\r\n| entry[].triggerred\\_by_event \t|  \t 问卷/评价触发事件    | \t   |\r\n| entry[].delivery_method    \t     |  投放方式\t     |   \t |\r\n| entry[].system_link  \t     |  \t 数据分享链接    | \t   |\r\n| entry[].submitted_on  \t     |  \t 提交方式    | \t   |\r\n\r\n\r\n# **自定义字段API Code**\r\n为了方便在多个 campaign 之间存储相同类型的业务数据，浩客支持[自定义问卷/评价的 API Code](https://howxm.com/help/articles/api#api-code)。\r\n\r\n\r\n","featured":false,"category_id":16,"created_at":"2023-06-30T09:49:49.557Z","updated_at":"2023-11-28T11:22:58.273Z"}