本客服平台由提供产品服务

智能触达-Webhook配置文档

诸葛君发表于:2017年05月18日 17:34:58更新于:2017年08月03日 16:51:39

概述

诸葛智能触达Webhook可以让您自定义营销行为。Webhook是一个HTTP形式的接口,该接口需要您来提供。当智能触达检测到用户满足设置的行为条件时,会去回调请求该接口,并把该用户的基本信息以JSON格式的请求体传递给您,您可以在接口中利用这些信息做任何想做的事情,比如给用户发送短信、推送、邮件、红包,记录用户的行为或进行一些复杂的业务计算。


接口和数据格式


请求方法 

目前只支持POST形式的请求。

请求头

Content-Type: application/json; charset=utf-8
User-Agent: ZhugeIO-Webhook/1.0
X-ZhugeIO-ReqID: 55f168b8-5626-11e7-8ef6-6c40088b9060
X-ZhugeIO-HookType: marketing_cloud_activity
X-ZhugeIO-DataType: single


需要说明的是X-ZhugeIO-ReqID字段,该字段为每个请求提供了一个唯一ID进行标识,您的开发人员以及诸葛的技术人员都可以通过该字段来定位到每一次请求进行排错。

请求体


{
"activity": {
"activity_id": 10010,
"activity_name": "注册送十元优惠券活动",
"activity_type": "event"
},
"user_properties": {
"手机号": "17600817832",
"邮箱": "chihongze@zhugeio.com",
...
}
}

请求体分为了两个部分,其中activity是活动相关的信息,当您多个活动使用同一个Webhook但不同的活动又有一些业务逻辑差别的时候可以使用该部分数据做区分;user\_properties是用户属性,就是您在SDK中上传的用户属性。

注意:如果检查到当前用户没有任何属性,那么智能触达系统将不会调用Webhook


返回结果

智能触达根据Webhook接口返回的HTTP状态码来判断成功失败,如果返回的状态码是2xx,那么就会认为执行成功,同时发送成功计数会+1,如果是其它的状态码,那么会认为执行失败,发送计数不会增加。


具体配置过程

进入「营销」模块,创建活动时,选择动作为webhook。

blob.png

选择后,填写回调地址即可保存webhook配置。当智能触达检测到用户满足设置的行为条件时,会去回调请求该接口,接口将会负责执行之后的相关逻辑。

blob.png



注意事项

超时

如果您的Webhook接口响应特别的缓慢,那么智能触达不会一直等待下去,默认等待超时时间是10秒。超时会按照发送失败来处理。

建议您不要在Webhook中进行耗时的计算,而是进行简单处理后立即返回,如果确实需要进行很耗时的计算,那么可以将Webhook中接收到的数据封装成事件,发布到消息队列中,在后台的Worker中进行计算。

安全

建议对Webhook的访问提供限制,只在智能触达被部署的内网可访问。

调试和问题排查

在第一次对接时,不要马上就执行真实的业务逻辑,尤其是发送类的业务,建议先使用一个空的Webhook,只把接受到的参数打印出来,人工观察数据没有问题以及请求压力可接受后,再对接正式的业务。

另外建议将收到的请求数据和唯一请求ID记录日志,方便问题的排查。如果无法排查,请及时联系我们的技术支持人员。




    您需要登录后才可以回复