Webhook 业务介绍

功能概述

Webhook 是一个 HTTP 形式的回调接口，用以支持自定义的营销行为，该接口需要研发团队一些开发工作，详见 Webhook 对接文档
当用户被触发（满足计划中的条件）时，会去回调请求 Webhook 接口，并把该用户的基本信息或其他自定义内容以 json 格式的请求体传递给客户的服务器，客户就可以在接口中利用这些信息进行后续的操作，比如，对用户进行消息推送、权益发放等。

适用场景

1、客户已经拥有了一套消息推送平台，那么这种情况下就可以编写一个 Webhook 进行中转，在“用户运营解决方案”与已对接的推送通道之间做一个适配。

2、对接权益系统，利用“用户运营解决方案”灵活的规则定义来触发优惠券、积分的发放（按用户筛选条件选取、按事件触发选取）。

创建Webhook

在用户运营解决方案-运营计划-webhook-通道管理页面，选择新建webhook

填写webhook名称、输入请求地址

1、添加用户属性

可添加多条用户属性，配置成功之后，运营人员在创建计划时不需要定义这部分的内容，配置好的动态参数会自动加到请求体里。建议创建人员和相关技术对齐后填写

• 参数名称：自定义发送的用户属性参数的名称，必须为英文开头，不支持符号、纯数字；为请求里的 Key。

• 属性参数：选择要发送的用户属性。

• 默认值：当属性值为空时使用默认值。

最多添加10个用户属性

2、模板参数

可添加多个模板参数，配置成功之后，运营人员在创建计划时可以灵活定义这些模板参数的值。比如配置了模板参数标题、内容，那么后续每次创建计划时就可以灵活定义发送的标题和内容。

• 参数名称：自定义发送模板参数的名称，必须为英文开头，不支持符号、纯数字；为请求里的 Key
• 显示名称：在【创建流程画布任务－营销配置 - webhook通道】页面里显示的名称。
• 参数类型：目前支持创建的类型为字符串型、文本型、数值型3种；其中仅文本型支持插入用户属性；数值型包括小数、整数、百分比三种。
• 添加提示文案：提示运营人员当前参数的输入规范。
• 添加选项：当参数类型为字符串型、文本型、数值型时，支持添加参数选项。编辑完选项后，可以设置默认项，默认项将会在运营人员配置参数时自动填充到输入框。
• 设置必填：至少勾选 1 个模板参数作为必填项，运营人员在使用 Webhook 时，必填参数全部填写才能提交。

举例：

创建webhook时的配置：

模板参数-添加选项：

在流程画布-营销配置-webhook选用的配置界面，如下图：

3、测试发送

webhook通道创建成功后，通道默认关闭，可以先进行测试发送，确定能发送成功后再开启通道。

点击测试，填写测试发送信息。

点击确定，返回发送成功或失败状态，支持根据日志查看原因。

创建webhook任务

在“用户运营解决方案“或”点击提升方案“中，运营计划-流程画布，配置进入流程条件、选取目标用户

在营销配置渠道中，选择webhook通道

选择对应的webhook通道

时机设置，支持立即发送和延时发送，其中延时设置：指满足任务开始时机和目标用户群条件后，是否要立即触发营销动作。如客户首次注册15分钟后，给客户发送一个免费领取VIP的推送提醒

触达内容，按照所选的webhook通道对应的字段内容填写即可

流程画布操作手册，具体可见：https://docs.getui.com/ido/start/intelligent_operation/