文档目录

目录

Webhook消息格式

Webhook支持如下几类消息：自定义消息、线索事件、线索属性变更、线索身份变更和会员事件。下面分别对各种消息的格式一一做说明。

自定义消息

自定义消息在手动发送、自动流程和提交表单时发送的Webhook中会使用。Webhook发送的消息格式会按照用户定义的格式发送，同时会替换里面的变量。

示例:

自定义JSON消息体:

{
  "姓名":"${name!\"\"}",
  "公司":"Convertlab"
}

Webhook消息接收地址接收到的消息内容:

{
    "姓名": "荟聚",
    "公司": "Convertlab",
    "MESSAGEID": "6f883839ec224526a1ecbb59ca8f5277"
}

JSON消息还会随消息携带一个MESSAGEID，用于方便定义问题。

自定义TEXT消息体:

  ${name!\"顾客\"}, 你好!

TEXT消息内容:

    顾客, 你好!

自定义消息支持的变量

除了可以在界面中插入的变量，如线索变量，会员变量等。自定义消息还支持如下变量：

  • tenantId: 发送消息的租户ID
  • customerId: 对应的线索ID
  • campaign: 对应的营销活动编码
  • webhookId: 对应的Webhook Id
  • batchId: 该次发送的批次号（不一定有）

自动流发送的Webhook还可以使用如下变量:

  • flowId: 自动流程ID
  • flowVersion: 自动流程版本号
  • flowStep: 自动流程的步骤ID

线索事件

对于订阅了线索事件的Webhook，在线索事件发生时，荟聚会将事件的内容发送给消息接收地址。Webhook可以订阅系统事件和自定义线索事件。当Webhook订阅了多个线索事件时，多条事件会依次发送给接收地址，而不是一次性发送多条。下面以点击微信菜单事件为例来说明消息的格式。

示例：

事件类型：点击微信菜单事件
事件关键字：click_menu
消息内容: 

{
  "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
  "topic": "customerEvent",
  "data": {
    "event": {
      "createdDate": "2020-08-18T08:14:31.548Z",
      "type": "created"
    },
    "object": {
      "id": "784697835080734720",
      "tenantId": 1,
      "customerId": "577610832247089152",
      "channelType": "wechat",
      "channelAccount": "1234",
      "event": "click_menu",
      "targetId": "kdfb9nho734l6",
      "targetName": "会员福利",
      "date": "2020-08-18T08:14:29.285Z",
      "userId": "okY_5jvvwjyrGzEFrHgSCIJ96GgY",
      "identityType": "wechat",
      "identityValue": "okY_xxxj_openid",
      "lastUpdated": "2020-08-18T08:14:31.432Z"
    }
  }
}

字段说明:

字段说明
MESSAGEID本次发送的消息ID，用于调试
topic本次消息发送的类型，线索事件的topic都为customerEvent
datawebhook的消息内容
data.event事件的类型和发生的事件，对于线索事件Webhook消息，类型都是created
data.object线索事件的内容，具体参照线索事件

线索属性变更

对于订阅了线索属性变更的Webhook，在线索属性发生变更时，荟聚会将发生变更的属性内容发送给消息接收地址。Webhook可以订阅系统事件和自定义线索事件。下面以线索公司属性发生变更为例来说明消息的格式。

示例：

消息内容: 

{
    "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
    "data": {
        "event": {
            "createdDate": "2020-08-18T08:14:31.548Z",
            "type": "updated"
        },
        "object":{
            "customerId": "577610832247089152",
            "name": "张三",
            "company": "百度",
            "id": 1999
        } 
    },
    "topic": "customer"
}

字段说明:

字段说明
MESSAGEID本次发送的消息ID，用于调试
topic本次消息发送的类型，线索属性变更的topic都为customer
datawebhook的消息内容
data.event事件的类型和发生的事件，对于线索事件Webhook消息，类型可以是created,updated，deleted
data.object线索属性的内容，具体参照查询线索

线索身份变更

对于订阅了线索身份变更的Webhook，在系统线索发生增删改变更时，荟聚会将事件的线索内容发送给消息接收地址。

示例：

消息内容: 

{
    "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
    "data": {
        "event": {
            "createdDate": "2020-08-18T08:14:31.548Z",
            "type": "deleted"
        },
        "object":{
            "id": 2850786358,
            "version": 1,
            "type": "wechat-unionid",
            "value": "ombkt1FfCsqV91SQZ-p5-HfXqDVY",
            "name": "小情绪",
            "tenant_id": 4209,
            "date_created": "2020-08-19 07:23:15",
            "last_updated": "2020-08-19 07:23:15",
            "customer_id": 785396805977360400
        } 
    },
    "topic": "customerIdentity"
}

字段说明:

字段说明
MESSAGEID本次发送的消息ID，用于调试
topic本次消息发送的类型，线索属性变更的topic都为customer
datawebhook的消息内容
data.event事件的类型和发生的事件，对于线索身份变更Webhook消息，类型可以是created，deleted
data.object线索身份相关信息
data.object.id事件ID
data.object.version版本号
data.object.type线索来源类型
data.object.value变更后的值
data.object.name姓名
data.object.tenant_idtenantId
data.object.date_created创建时间
data.object.last_updated更新时间
data.object.customer_id线索ID
data.object.value_md5value_md5