Webhook 触发器

帮助中心

智能助手

帮助中心智能助手上线

我能为你解答飞书使用的问题，快来问问我吧！

点击按住可拖动视频

我知道了

去试试

Webhook 触发器

本文阅读时长：5 分钟

一、功能简介

🔖

说明：此功能同时适用于创建机器人应用和机器人指令。

Webhook 又叫“网络钩子”，是应用给其它应用提供实时信息的一种方式。通过 Webhook ，系统可以在收到 HTTP/HTTPS 请求时，自动触发流程运行。

飞书机器人助手提供 Webhook 触发能力，企业可以通过 Webhook 将业务系统与飞书机器人助手连接起来。通过 Webhook，无需代码编辑，就可以实现从其他应用或服务自动接收数据。比如：

当内部 CRM 系统中新增客户时，通过机器人发送飞书消息。

当系统出现告警时，通过机器人发送飞书消息。

将你自建的落地页或收集的线索等快速归档，记录到到多维表格或电子表格中。

二、操作流程

打开飞书机器人助手，点击 + 新建机器人应用，配置新应用的名称、描述和图标。在流程设计中点击 ➕ 创建流程。

250px|700px|reset

进入选择触发器界面，选择 Webhook 触发作为触发器。

250px|700px|reset

复制页面上提供的 URL。将复制的 URL 添加到你想配置 Webhook 地址的应用，实现从飞书接收来此应用的数据。

250px|700px|reset

回到配置界面，填写 Webhook 推送的 JSON 数据格式或示例数据，对应的 key 值可以被后续流程节点消费。

注：参数需要用大括号 {} 括起来，由 message_type 和键值对组成。message_type 必须为文本类型，键是字符串，值可以是字符串、数字、布尔值、数组、对象或 null。如下图所示，如果你想要获取 ID 字段，可以在参数中填写示例数据 "id": 1；如果你想要获取姓名字段，可以在参数中填写示例数据 "name":"Tom"。

250px|700px|reset

以通过官方机器人发消息节点为例，前序 Webhook 节点中的 key 值可以被消息内容消费。

250px|700px|reset

完成配置后，你可以通过 curl 指令，向以上 Webhook 地址发送一个 HTTP POST 请求，进行功能测试。

macOS 系统：在电脑上打开“终端”应用程序，并执行以下命令。

curl -X POST -H "Content-Type: application/json" \​
    -d '{"msg_type":"text","content":{"id":"1","name":"Tom"}}' \​
    此处填写 Webhook 地址​

Windows 系统：在电脑上用快捷键 Win + R 打开运行对话框，输入 cmd 并按回车键。在命令窗口执行以下命令。

curl -X POST -H "Content-Type: application/json" ​
    -d "{\"msg_type\":\"text\",\"content\":{\"text\":\"request example\"}}" ​
    此处填写 Webhook 地址​

三、常见问题

问：Webhook 触发器参数是否支持提取对象中的数组？

答：不支持。