1.功能概述
用户可以通过创建Webhook订阅,实现下游系统对CDP特定模块消息的即时感知和响应。
例如:创建“新建标签”消息类型的Webhook后,用户在标签体系中进行新建标签动作时,下游系统会立马感知到该消息。
2.使用前提
仅项目管理员可以使用该功能模块。
3.概念解释
Webhook 是一个 API 概念,是微服务 API 的使用范式之一,也被成为反向 API,即前端不主动发送请求,完全由后端推送。传统方法中,客户端从服务器请求数据,然后服务器提供给客户端数据(客户端是在拉数据),在 Webhook 范式下,服务器更新所需提供的资源,然后自动将其作为更新发送到客户端(服务器是在推数据),客户端不是请求者,而是被动接收方。降低了下游轮询问的压力。
简单来说,Webhook 就是一个接收 HTTP POST(或GET,PUT,DELETE)的URL,一个实现了 Webhook 的 API 提供商就是在当事件发生的时候会向这个配置好的 URL 发送一条信息,与请求-响应式不同,使用 Webhook 你可以实时接受到变化。
4.操作步骤
4.1 创建Webhook
- 前往VeCDP-项目中心-开放平台-Webhook管理页面,点击 创建Webhook 按钮;
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/39dbaa2e48d247cca187a9ec4e8bb64b~tplv-goo7wpa0wc-image.image)
- 填写Webhook配置信息:
- Webhook名称:输入一个易于识别的名称;
- Webhook描述:填写Webhook的详细描述,以便日后快速理解其用途;
- 消息类型:例如新建标签、修改标签等;(此处支持选择的消息类型即 开放平台-开放能力-消息通知 页面中所列的类型)
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/9f3194c13720463bac3714ca4124df4a~tplv-goo7wpa0wc-image.image)
- 消息接收地址:输入接收Webhook通知的服务器地址,需要是真实、可接收消息的地址;
- 应用:选择与Webhook关联的应用,即在开放平台-应用管理 功能模块中配置的应用。
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/9d8824356fa945e3be0bacc53dafc1c4~tplv-goo7wpa0wc-image.image)
- 开启鉴权:选择"开启鉴权"选项,系统会自动将应用关联的AK(Access Key)信息包含在推送的消息中。这样,下游用户可以通过验证AK来确保消息确实来自VeCDP平台。具体的鉴权逻辑和接入方法,可以参照CDP开放能力的相关文档;
- 消息格式:仅JSON格式
- Webhook测试:完成配置后,用户可以进行Webhook测试以确保配置正确无误,点击"Webhook测试"按钮,系统将发送一个测试通知到指定的接收地址。
- 自动重试次数:填写次数即可,启用"支持自动重试"功能,可以在消息发送失败时自动尝试重新发送,提高消息送达率。
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/276bac04e4984c44bb6f7ba67246382a~tplv-goo7wpa0wc-image.image)
4.2 Webhook管理
在Webhook管理列表页面,用户可以查看Webhook的详细信息,包括名称、创建人、创建时间、最近编辑人、最近编辑时间等基本信息。
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b1c3483194ad496ca7c415c38ba54c34~tplv-goo7wpa0wc-image.image)
在操作栏,支持:
- 编辑:允许用户修改Webhook的配置信息,如名称、消息类型等。
- 删除:提供删除Webhook的选项,用于移除不再需要的Webhook。
- 查看日志:允许用户查看与该Webhook相关的详细日志信息,包括发送详情和错误报告等。
![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/44f87449ec1d4c218e7629dc26f05447~tplv-goo7wpa0wc-image.image)