我想建立適用於全體成員使用的Team Outgoing Webhook

Dahlia2024-10-28

Outgoing Webhook 是當從 JANDI 生成包含特定關鍵字的訊息時，可以將此訊息轉發到外部服務的一個功能。Team Outgoing Webhook是可以允許成員在JANDI私訊中的訊息檢查的功能。

[Team Outgoing Webhook 概要]

Outgoing Webhook是當 JANDI 中出現包含特定關鍵字的訊息時，可以將此訊息轉發給外部服務器。

若使用 Team Outgoing Webhook，管理者將負責管理Webhook的修改與刪除，只要管理者串聯成功，所有團隊成員都可以使用相同的功能，且成員無須修改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

Plaintext

{
"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：

Plaintext

{
"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個，並且僅提供給付費方案中使用。點擊下方連結以升級您的方案！

https://www.jandi.com/landing/zh-tw/pricing