Webhook管理

1、背景介绍

   当用户进入自动流的wehbook节点时,会去回调请求 Webhook 接口,并把该用户的基本信息或其他自定义内容以 json 格式的请求体传递给客户的服务器,客户就可以在接口中利用这些信息进行后续的操作,比如,对用户进行消息推送、权益发放等。

2、操作步骤

   营销自动化→营销触达→Webhook管理→新建webhook模版→自动流触达

2.1 新建创建webhook

   在Webhook管理列表页,点击创建webhook,进入创建页面

1)输入wehook名称,作为系统的显示名称

2)请求地址:Http形式的请求地址

3)鉴权方式,支持鉴权方式包括:

   a. 密钥:选择密钥方式,弹出输入密钥的输入框

   b. Basic Authentication:选择 Basic Authentication 方式,弹出输入 用户名和密码的输入框

   c. 自定义:选择自定义鉴权方式,可通过定开的方式开发鉴权

   d. 无:表示接口无需鉴权

4)QPS上限:非必填,不填默认上限为800

5)发送ID:选择发送 ID 在CDP存储的身份字段,如,通过 Webhook 对接APP消息,那发送 ID 这里选择APP推送平台的ID。

6)接口发送方式:单次发送、批量发送

7)请求响应、发送回执:支持开启、关闭

8)图标:每个创建成功的webhook模版会作为一个独立的节点以上传的图标显示在自动流中

9)用户属性:可添加多条用户属性,配置成功之后,运营人员在在新建自动流webhook节点时不需要定义这部分的内容,配置好的用户属性会自动加到请求体里。

   a. 参数名称:自定义发送的用户属性参数的名称,必须为英文,为请求里的 Key

   b. 用户属性:选择要发送的CDP用户属性。

   c. 默认值:当属性值为空时使用默认值,非必填

10)模版参数:可添加多个模板参数,配置成功之后,运营人员在新建自动流webhook节点时可以灵活定义这些模板参数的值,比如配置了模板参数标题、内容,那么后续每次创建计划时就可以灵活定义发送的标题和内容

   a. 参数名称:自定义发送模板参数的名称,必须为英文,为请求里的 Key。

   b. 显示名称:在「自动流画布-webhook」配置弹窗里显示的名称。

   c. 参数类型:目前支持创建的类型为文本、长文本、枚举值(单选)、枚举值(多选)、整数、实数、日期、日期与时间、动态参数、iframe、图片;

   d. 添加提示文案:提示运营人员当前参数的输入规范。

   e. 添加选项:当参数类型为枚举值(单选)、枚举值(多选)时,支持添加参数选项。编辑完选项后,可以设置默认项,默认项将会在运营人员配置参数时自动填充到输入框。

   f. 设置必填:至少勾选 1 个模板参数作为必填项,运营人员在使用 Webhook 时,必填参数全部填写才能提交。

image214.png

image216.pngimage218.pngimage220.pngimage222.png

2.2 开启关闭wehook

   添加 Webhook 后,默认关闭,需要手动开启

1)Webhook 开启后,新建自动流时可显示该webhook节点。

2)Webhook 关闭后,新建自动流画布时不可使用,已建自动流关闭该webhook 会导致流程停止运行;点击关闭时将弹窗显示受影响的流程,确认关闭后将暂停受影响的计划和流程。

image224.png

2.3 消息防骚扰设置

   列表页支持对webhook模版设置消息防骚扰,点击【防骚扰设置】跳转到防骚扰页面

2.4 删除 webhook

   关闭Webhook 后才可以删除。删除后,使用了该Webhook的自动流仍支持查看,若对这些受影响的流程进行编辑、复制,将清空已删除的wehook模版。

2.5 自动流使用webhook节点

image226.png