Webhook

Webhook 是一种高级集成功能,当启动特定事件(例如开始远程会话或屏幕共享会话)时,可向已配置的 URL 触发通知。您可以通过单个回调 URL 接收任意数量的事件。Webhook 功能仅在 Zoho Assist 企业版 中提供支持。

创建 Webhook

  1. 步骤 1:登录 Zoho Assist
  2. 步骤 2: 前往 设置 > Integrations > Webhooks
  3. 步骤 3:选择 添加 Webhook

  4. 步骤 4: 添加Name、描述和回调URL。

当事件被触发时,将生成一个来源 ID。来源 ID 是分配给 webhook 的可自定义 ID,用于防止针对同一事件触发的通知循环。

  1. 步骤 5:单击 Ping URL 以测试回调 URL
  2. 步骤 6: 从“选择事件”下方的下拉菜单中选择模块、事件Name和部门

Webhook 事件与各自的事件 ID 相对应,如下所示:

 Webhook 事件

事件ID

 外呼会话开始

0

 会话开始 - 屏幕共享

1

 会话结束 - 远程支持

2

 会话结束 - 屏幕共享

3

 Customer 加入 - 远程支持

4

 入站请求创建

5

 入站请求转移

6

 入站请求委托

7

 已选择入站请求

8

 入站请求已被拒绝

9

 入站请求已丢弃

10

 入站请求已过期

11

 设备 添加

12

 设备在线

13

设备离线

14

 设备 Delete

15

 会话开始

16

 会话结束

17

  1. 步骤 7:点击“Ping 事件”来测试所选事件,以此触发针对该事件的测试运行。
  2. 步骤 8:单击“管理参数”以打开 JSON 编辑器,允许用户修改其自定义的 JSON 配置。

此功能为客户提供了一种灵活的方式,可以根据自身需求定制其 Webhook 数据。

  1. 步骤 9:在完成对 JSON 的修改后,点击 Save 以确认并应用您的更改。

    • Beautify(美化), 帮助为您的 JSON 进行结构化,以便与第三方应用程序无缝通信。
    • Insert Params(插入参数), 使您能够根据需要轻松加入特定参数。
  2. 步骤 10:点击“Create Webhook”

已创建的 webhook 可以随时从 webhook 菜单中访问和编辑

注意:

  • 您最多可以创建二十个 Webhook,并且每个事件最多可以配置 10 个 Webhook。
  • Webhook 需要通过第三方集成才能运行。

API 集成:

OAuth Scopes:

  • ZohoAssist.webhooks.READ
  • ZohoAssist.webhooks.CREATE
  • ZohoAssist.webhooks.UPDATE
  • ZohoAssist.webhooks.DELETE
  • ZohoAssist.webhooks.ALL

 属性 Name

 数据类型

 描述

 姓名

 字符串

 Name

 描述(可选)

 字符串

 Webhook 的描述

 网址

 字符串 - 有效的 https URL

 必须发送事件信息的服务器端点。

 ignore_src(可选)

 字符串

 客户端 ID 被排除在触发 Webhook 之外。 

 订阅

 订阅数组

 您想要订阅的事件。

 状态

 0(禁用)或 1(启用)

 Webhook 状态

 hook_id

 长

 实例中钩子实体的主键(pk)

 事件_ID

 整数

 事件的 ID。

 部门ID

 long[]

 各部门 ID 即时获取

上一页

下一页