全部系列
協作工具
JANDI Connect
如何接收 Incoming Webhook?
如何接收 Incoming Webhook?
一週前已更新

Webhook 是什麼?

Webhook 是透過預設格式匹配的數據並將通知發送到指定的 JANDI 聊天室的功能。如果 JANDI Connect 不支持某個服務,但支援 Outgoing Webhook,它可以與 JANDI 連接並接收有關不同更新的通知。

* 提示:您可以請開發人員或IT部門協助,以輕鬆設定 Webhook。


步驟1

通過消息向 JANDI 中生成的 Webhook URL 發送信息(HTTP POST 請求)。您必須在請求中指定 Accept 和 Content-Type,如下所示:

  • Accept: application/vnd.tosslab.jandi-v2+json

  • Content-Type: application/json


參考:JANDI Webhook 在restful API 中工作,因此您必須將http method置為POST。如果您將其設置為其他方法,它將不起作用。


步驟2

POST 請求如下:

{
"body" : "[[PizzaHouse]](http://url_to_text) You have a new Pizza order.",
"connectColor" : "#FAC11B",
"connectInfo" : [{
"title" : "Topping",
"description" : "Pepperoni"
},
{
"title": "Location",
"description": "Empire State Building, 5th Ave, New York",
"imageUrl": "http://url_to_text"
}]
}

每個字段具有以下功能。

  • “body”:一般訓的內容。在 JANDI 上發送一條訊息,將會在您看到的畫面中呈現。

  • “connectColor” :在上方的範例訊息中,您可以指定附件區域的顏色,該區在正文訊息的底部被劃分為一個單獨的區域,為十六進位碼 (Hex 色碼)。

  • “connectInfo”:在上方的範例訊息中,這是定義將包含在附件區域中的內容。

  • “title”:附件區域的標題,默認粗體顯示。

  • “description”:附件區域的詳細資訊。在上方的範例訊息中,可以根據訊息結構添加多個標題和描述。

  • “imageUrl” 如果 Webhook 訊息中附加了圖像文件,您可以透過輸入url 來接收webhook及圖像。

接下來是 curl 請求的範例。如果在終端等命令行環境(CLI) 中運行,您可以實際在JANDI 檢查訊息。

但在測試之前,請不要忘記將https://wh.jandi.com/connect-api/webhook/generated-link-in-JANDI' 部分替換為您在 JANDI 中實際建立的 webhook 地址。

curl \
-X POST https://wh.jandi.com/connect-api/webhook/generated_webhook_url \
-H "Accept: application/vnd.tosslab.jandi-v2+json" \
-H "Content-Type: application/json" \
--data-binary '{"body":"[[PizzaHouse]](http://url_to_text) You have a new Pizza order.","connectColor":"#FAC11B","connectInfo":[{"title":"Topping","description":"Pepperoni"},
{"title":"Location","description":"Empire State Building, 5th Ave, New York","imageUrl":"Url_to_text"}]}'

請參考: 此篇文章


小提示:

  1. 即使在您使用的服務中有支援 Webhook的服務,您也必須那個服務中發生的事件轉換成 JANDI 每次可以組合成訊息的格式,才能正常接收。您可以開發自己的流程也可以透過第三方服務如Zapier來對其進行配置。

  2. JANDI 中可顯示的訊息最大數量為 5000 個字元,透過 Webhook 可以接收的最大數據為 256kb。 256kb 是超過260,000個字元大小,對一般使用來說已經足夠了,但是如果接收的數據超過256kb,就會返回錯誤信息。

  • 具體來說,如果您透過 Webhook 發送包含 250,000 個字元的訊息,將僅顯示 5000 個字元。

  • 如果您發送包含 270,000 個字元的訊息,則訊息將不會生成。

是否回答了您的問題?