飞书智能伙伴Aily之自定义触发器(webhook) - 飞书官网
产品功能

飞书智能伙伴Aily之自定义触发器(webhook)

飞书

2024-12-23

功能介绍​
配置Webhook触发器​
功能介绍 ​
Webhook 又叫“网络钩子”,是应用给其它应用提供实时信息的一种方式。通过自定义触发器 Webhook 功能,可以在收到 HTTPS 请求时,主动执行技能。 ​
通过 Webhook(自定义触发器)功能可以将 AI 能力与现有企业系统、三方应用无缝结合,扩展企业、三方系统应用的 AI 能力(比如当收到自定义触发地址请求后执行 AI 技能;通过 webhook 的同步功能获取 AI 技能结果用于系统消费) ​
注:此功能较为复杂,可能需要具备一定的代码能力才能完整使用。 ​
常见的 Webhook 使用场景和实践: ​
  • 将 Aily 的 AI 能力接入到 多维表格:你可以从业务流程的痛点和需求出发,通过 Aily 任务的webhook 功能将 AI 技能用于多维表格中,实现表格类业务产品的 AI 增强。比如表格中一些「检查 base 内容是否重复」、「AI打标」、「企业信息查询」、「链接内容提取总结」等场景。更详细的配置可查看Aily X Base 的一点解决方案,自行配置接入。 ​
  • 工单处理质检和知识沉淀:监听到工单结束后发送 webhook 请求自动对群聊沟通内容质检,保证100%质检。同时触发自动总结群消息技能,智能生成对应的FAQ并同步到对应的云文档中,提高知识库迭代和后续排查效率。 ​
  • 智能监控和告警分析:企业内部有较多支撑公司核心业务流程的外部系统,譬如CRM系统、监控报警系统等,当系统检测业务异常报警时,除了及时告知你响应外,还能智能给出报警信息解读以及对应的排障建议。 ​
配置 Webhook 触发器 ​
1.1 选择 Webhook 触发 ​
在触发器中,选择「 自定义触发」。添加后,会展开 Webhook 触发器的配置面板 ​
​
250px|700px|reset
​
​
1.2 配置触发器内容 ​
​
250px|700px|reset
​
​
配置项及说明如下: ​
​
配置项 ​
解释说明 ​
Webhook 地址 ​
  • 使用 POST 请求方法向 Webhook URL 发送 HTTPS 请求时触发。请妥善保存地址,以免发生恶意调用 ​
Bearer Token ​
  • 向 Webhook URL 发送 HTTPS 请求时,请求头必须包含该 Token,用于完成请求的安全校验。 ​
输出设置 ​
  • 你可以在定义好传给这个Webhook URL 的数据格式,以便参数在后续执行技能时作为入参使用。若不使用,则无需设置 ​
  • 支持通过手动和JSON两种方式设置参数,在后续向 Webhook URL 发送请求时,需要以 JSON 格式传入参数值。 ​
响应方式 ​
  • 异步响应:接收到请求后,先响应调用方,再执行技能(返回系统默认的响应内容) ​
  • 同步响应:接收到请求后,先执行技能,结束后再响应调用方(返回技能通过结束节点定义的出参内容) ​
​
1.3 webhook 响应内容 ​
同步响应 ​
接收到请求后,先执行技能,结束后再响应调用方,并给调用方返回技能结束节点定义的出参内容。适用于需要返回给技能调用方技能出参的场景,例如查询或读取技能出参请求 ​
可以在技能「结束节点」中设置要响应的参数内容 ​
​
250px|700px|reset
​
​
同步响应示例: ​
​
{​
"data": {​
"code": "0",​
"data": {"data1":"测试","data2":11},//技能结束节点定义的出参内容​
"message": "success"​
},​
"status_code": "0"​
}}}
​
异步响应 ​
接收到请求后,先响应调用方,再执行技能(返回系统默认的响应内容)。适用于技能调用方不关注技能执行后出参的场景,例如事件推送或通知类请求 ​
异步响应示例: ​
​
{​
"data": {​
"code": "0",​
"data": "1803656458590212",//异步任务id(默认响应数据)​
"message": "success"​
},​
"status_code": "0"​
}}}
测试 Webhook 任务 ​
在开发调试阶段,您可以在任务编辑页面中,单击测试。 ​
在测试面板中,配置模拟触发的参数后,点击底部“执行测试”按钮,即可使用该数据进行测试。触发后执行技能的结果可以在「调试和预览」中查看。 ​
​
250px|700px|reset
​
​
线上运行 Webhook 任务 ​
  • 当应用发布后,需要向触发器的 Webhook URL 发送 HTTPS POST 请求,触发任务执行技能。 ​
以 HTTPS 请求为例 ​
请求 ​
​
基本 ​
​
HTTP URL ​
触发器真实的 Webhook 地址(可在任务详情页的触发器中复制 URL) ​
HTTP Method ​
POST ​
​
请求头 ​
​
名称 ​
类型 ​
必填 ​
描述 ​
Authorization ​
​
string ​
​
是 ​
通过 Authorization 完成请求校验来确保安全性,值为触发器真实的 Bearer Token ​
比如Bearer Token为0.gwejz383bi4 ​
那么值为 Bearer 0.gwejz383bi4 ​
​
请求体 ​
​
基本 ​
​
data ​
  • HTTPS POST 请求包含的数据内容,为 JSON 格式的请求参数体。 ​
  • 如果触发器的「输出设置」中设置了输出参数,那么请求体接收到的参数,可以在后续执行技能时作为入参使用 ​
​
响应 ​
根据触发器配置的响应方式返回对应的响应体内容 ​
同步响应示例: ​
​
{​
"data": {​
"code": "0",​
"data": {"data1":"测试","data2":11},//技能结束节点定义的出参内容​
"message": "success"​
},​
"status_code": "0"​
}}}
​
异步响应示例: ​
​
{​
"data": {​
"code": "0",​
"data": "1803656458590212",//异步任务id(默认响应数据)​
"message": "success"​
},​
"status_code": "0"​
}}}
常见问题 ​
  1. Webhook 触发的任务「限流」说明: ​
  • 同步情况下,最多等待100秒,响应即将返回 ​
  • 同一个任务,同一时间最多包含 30 个处于执行中状态的任务实例 ​
预约飞书企业效能顾问 深度诊断企业痛点,定制专属 AI 办公方案

先进团队,先用飞书

欢迎联系我们,飞书效能顾问将为您提供全力支持
分享先进工作方式
输送行业最佳实践
全面协助组织提效
标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题标题

字节跳动旗下 AI 工作平台

联系我们立即试用