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

什么是Webhook?如何通过Webhook同步数据到大猫平台?

JamesZhu发表于:2018年04月13日 13:37:03更新于:2018年04月13日 14:53:33

在认识Webhook这一名词之前,您可以回想一些生活中的简单场景,比如当您通过支付宝完成一次商品支付后,通常您会收到来自银行的短信消费提醒或者银行的微信公众号推送的消费通知 等等,那么你在一个应用程序中的某些行为,另外一个应用如何获取到,并作出进一步的操作呢? 类似这样的场景,就可以通过webhook方式简便的实现。


简而言之,Webhook是可以实现一个应用程序向另一个应用程序自动推送信息的一种简单方式。

接下来我们来简单介绍下,如何通过webhook将数据自动推送到大猫平台,目前我们实现了将第三方数据通过Webhook同步到大猫平台,暂不支持将大猫数据推送到第三方。


1、您可以通过客户页面》添加客户》通过webbhook同步客户

image.png


2、进入Webhook管理页面,系统会自动生成Webhook的请求地址。

Webhook的请求地址是唯一的,如果需要更改此请求地址,可以点击重置请求地址,重新生成新的地址,这里需要注意的是,重置后,原来的请求地址将会失效,请谨慎操作。

image.png

另外,默认Webhook功能是关闭状态,只有在开启状态下才可以正常推送数据到大猫平台。


3、有了这个地址,是不是就可以推送任意数据到大猫平台呢?肯定不是的,拿到请求地址只是第一步,接下来还需要通过大猫平台的请求认证通过后,方可成功推送数据进来。

请求头参数(Request Headers )包括以下4个参数,其中User-Agent、X-BIGCAT-Action、Content-Type为固定参数,X-BIGCAT-Delivery参数就是页面内生成的令牌参数。注意:以上四个参数在Request Headers 为必传项,否则视为非法请求。

"User-Agent":"BIGCAT-WebHook-Server",
"X-BIGCAT-Delivery":"225bf09d9e478aa07692d724126600b996865555e38ad110b8e1f677a9ea2155a7eb747b79a1xxxxxx",
"X-BIGCAT-Action":"bigcat_import_new_contact_task",
"Content-Type":"application/json",


4、提交数据格式

提交数据各位为json格式,您可以参照以下格式提交,

注意:

1、提交数据字段中,邮箱为必传字段,其他字段为非必传字段,其中组名称字段为群组名称,如需将数据放入指定群组,则需传入群组名称,如果大猫系统还没有此群组,则自动创建。

另所有字段:均以字符串格式传入。

2、选项类型字段(如省份,城市),请传入选项文本,如 “广东”,“广州”

3、日期类型字段,请传入“ YYYY-MM-DD HH:MM:SS ” 符合这种格式的日期字符串,如“2018-04-04 21:17:00"

4、布尔类型,请传“是”或“否”

5、数字类型,请传数字字符串,如“100.0”

6、自定义字段的Key Name,请从 自定义字段列表 中获取,如“job_tier”

{
    "name": "张三",
    "company": "梅花网",
    "job": "产品经理",
    "email": "zhangsan@domain.com",
    "phone": "13800000000",
    "provinceStr": "广东",
    "cityStr": "广州",
    "address": "广东省广州市中山大道",
    "registeredSources": "sem",
    "gmtRegistration": "2018-04-13 14:50:06",
    "gender": "男",
    "gmtBirthday": "1990-04-13 14:50:06",//格式:yyyy-MM-dd HH:mm:ss
    "telephone": "65676666",
    "website": "http://www.meihua.info",
    "fax": "",
    "country": "中国",
    "postCode": "",
    "qq": "",
    "weibo": "",
    "weixin": "",
    "remark": "",
    
    //自定义字段
    "job_tier": "高管",
    ...
}




    您需要登录后才可以回复