1. 功能概述

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

2. 适用场景

  • 客户已经拥有了一套消息推送平台,那么这种情况下就可以编写一个 Webhook 进行中转,在智能运营与已对接的推送通道之间做一个适配。

  • 对接权益系统,利用神策智能运营灵活的规则定义来触发优惠券、积分的发放(受众筛选规则、行为触发规则)。

3. 创建 Webhook

点击右上角创建 Webhook

3.1. 输入 Webhook 名称

3.2. 输入请求地址

3.3. 选择发送 ID

选择发送 ID 在用户表里存储的属性字段,如,通过 Webhook 对接站内信,那发送 ID 这里选择登陆 ID。注意,创建计划进行预估受众时,会过滤掉发送 ID 为空的用户。Webhook 类型的计划里的计划触发、目标完成指标也都会过滤掉发送 ID 为空的用户。

3.4. 添加用户属性

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

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

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

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

3.5. 添加模板参数

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

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

  • 显示名称:在「创建计划-触达配置」页面里显示的名称

  • 参数类型:目前支持创建的类型为字符串型、文本型、数值型、日期型、图片型,其中字符串型不支持插入用户属性,文本型支持插入用户属性,数值型包括小数、整数、百分比三种。

3.6. 保存

  • 完成所有设置以后,提交保存,以下为配置的一个样例,供参考

  • 在创建计划-触达配置选择该 webhook 的配置界面,如下图

4. 测试发送

  • 账号创建之后,默认关闭,可以先进行测试发送,确定能发送成功后再开启账号。
  • 点击测试发送,填写测试发送信息

  • 点击下一步,预览之后发送,稍后右上角会返回发送回执,若发送成功,返回以下回执,若仍未收到,点击下载日志查看原因。

  • 若发送失败,返回以下回执,可点击下载日志查看原因。

5. Webhook 管理

5.1. 开启关闭 Webhook

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

  • Webhook 开启后,新建计划或流程画布时可使用。
  • Webhook 关闭后,新建计划或流程画布时不可使用,已建计划或流程画布的处理逻辑不同版本略有不同,如下
    • 智能运营 V1.5 以前,已建计划或流程画布仍可使用关闭的 Webhook。
    • 智能运营 V1.5 及 V1.5+ ,关闭时将弹窗显示受影响的计划或流程,确认关闭后将暂停受影响的计划和流程。同时对于使用了已关闭 Webhook 的计划或流程,以下几种情况将引导用户切换或重新开启
      • 启动暂停中的计划或流程,且这些计划或流程使用了已关闭通道。
      • 编辑暂停中的计划或流程,且这些计划或流程使用了已关闭通道。
      • 复制使用了已关闭通道的计划或流程。
      • 编辑使用了已关闭通道的流程画布的草稿。
V 1.5 以前V1.5 及 V1.5+

5.2. 编辑 Webhook

  • 已添加 Webhook 支持查看、编辑
    • 智能运营 V1.5 以前可以直接编辑。
    • 智能运营 V1.5 及 V1.5+ 需要关闭后才可以编辑。若编辑操作(如模板参数增减)影响了已建计划或流程,则对这些受影响的计划或流程进行编辑、启动、复制等操作时提醒用户进行确认或修改。
  • 根据实际运营需求,可添加多个 Webhook,如对接站内信、对接权益系统等。

5.3. 删除 Webhook

智能运营 V1.5 及 V1.5+ 支持删除 Webhook,但是需要关闭后才可以删除。删除后,使用了该 Webhook 的计划和流程仍支持查看,若对这些受影响的计划或流程进行编辑、启动、复制等操作将引导切换账号。

6. 接口和数据格式

Webhook 的接口对接文档详见 Webhook 通道接入 。