Outgoing Webhook 是当从 JANDI 生成包含特定关键字的信息时,可以将此信息转发至外部服务的一个功能。Team Outgoing Webhook是可以允许成員在JANDI 私信中的信息检查的功能。
[Team Outgoing Webhook 概要]
Outgoing Webhook是当JANDI 中出現包含特定关键字的信息时,可以将此信息转发给外部服务器。
若使用 Team Outgoing Webhook,管理者将负责管理Webbhook的修改与删除,只要管理者串联成功,所有团队成員都可以使用相同的功能,且成員無須修改Webhook。 JANDI 使用 /指令 (/command) 参数形式的 outgoing wekhook,並通过输入描述与参数范例来复制成员使用 webhook。 每個成員都可以通过 JANDI (1:1 私信) 输入webhook 信息並接收通知。
[如何设置 Team Outgoing Webhook]
JANDI 右上角工具列 > JANDI Connect 图示
於 JANDI Connect 列表 > 选择 Team Outgoing Webhook,您可以在串联选项中执行操作。
① 输入触发关键字:定义 /command 命令。命令最多可以输入50个字,不包含空格。
{触发关键字范例}
如果输入"出勤记录"作为触发关键字,則在实际信息输入栏中显示以下內容。 直接在信息输入栏输入"/" 或 [/] 命令键,並选择所需的触发关键字。
② 指令语/参数范例:参数最多可已输入100个字,参数说明最多可以输入50个字。输入参数值和参数描述,能便於他人查看与使用集成的Outgoing Webhook。一个webhook 最多可輸入10个参数。
请注意,您需要从指令列表中选择触发关键字,否則将不会被识别为 webhook指令。
{参数值与参数描述范例}
③ 集成描述:输入集成的描述,以便团队成員能更善用集成。
{集成描述范例}
④ Token:发送Webhook时,可以查看 Payload 中的token。
⑤ URL: 输入想要接收 JANDI 发送的团队webhook的 URL。
[Team Outgoing Webhook 发送 POST 数据]
在 Team Outgoing Webhook 数据中使用已登录的触发关键字创建信息时,会向已登录的 URL 发送 POST 请求。包含的数据如下。 ( JANDI webhook 遵循 JSON 格式。)
token | 用於集成验证的身分验证钥匙 (钥匙为自动生成,可供变更) |
---|---|
teamName | JANDI 团队名称 |
roomName | JANDI 聊天室名稱 |
writerName | 留言者名稱 |
writeEmail | 留言者Email |
text | 输入完整信息內容 |
keyword | 触发关键字 |
cratedAt | 信息输入时间 |
data | 沒有关键字的信息内容 |
platform | 生成 Outgoing 信息的平台 (web, ios, android) |
ip | 生成 Outgoing 信息的 ip |
[Team Outgoing Webhook 的Payload與Response]
① Payload
{
"token" : "YE1ronbbuoZkq7h3J5KMI4Tn",
"teamName" : "Toss Lab, Inc.",
"roomName" : "Bulletin Board",
"writer" : {
"id" : "20135452",
"name" : "Kevin",
"email" : "kevin@tosslab.com",
"phoneNumber" : "2061234567"
},
"text" : "/weather How is the weather in New York tomorrow?",
"data" : "How is the weather in New York tomorrow?",
"keyword" : "weather",
"createdAt" : "2017-05-15T11:34:11.266Z",
"platform" : "web",
"ip" : "12.345.67.89"
}
Outgoing Data:当包含在登录的触发关键字中的信息被输入时,一个POST请求会被发送到登录的URL。包含的数据如上。
② Response:
{
"body" : "[PizzaHouse] You have a new Pizza order.",
//Body text (Required)
"connectColor" : "#FAC11B", //Hex code color of attachment bar
"connectInfo" : [{
"title" : "Topping", //1st attachment area title
"description" : "Pepperoni" //1st attachment description
},
{
"title": "Location", "title": "Location"
"description": "Empire State Building, 5th Ave, New York"
//2nd attachement description }]
}
Responding:您可以通过对 POST 的响应值在已创建集成的聊天室中输入信息。响应的数据格式和信息输出与 集成 Incoming Webhook 的 POST数据相同。(上述格式以外的响应将被忽略,所有不同於 "200 OK" 响应的响应都不会被处理。)
Additional Formatting:可以在正文部分套用能表達信息效果的 markdown,例如"粗体"和"插入链接"。
但是,Team Outgoing Webhook是每个团队最多可以集成 10个,並且仅提供给付费方案中使用。点击下方链接以升級您的方案!