1. Incoming Webhook 是 JANDI 中的一個功能,允許接收外部數據。但是,每位用戶都必須經過以下流程,才能發送外部數據。
單獨建立 Incoming Webhook,並發送生成的URL給管理器。接著,管理器將 URL 與個人資訊進行比對後,並保存進行管理,若有任何人事異動或部門調動,管理者可以刪除 Webhook 或重新串聯。
由此可見,一旦建立串聯 Webhook,其實有點難管理團隊。為了解決這個問題,我們開發了Team Incoming Webhook。
當管理者或所有者將帶有訊息的個人標示(註冊為 JANDI 的電子郵件地址) 發送到來自於 Team Incoming Webhook 的 URL 時,可以啟用個人訊息傳遞。
這有助於 JANDI 用戶能自由地連接外部服務器,透過個人訊息的功能,依照工作條件發送至群組的訊,都使 JANDI 的使用更加廣泛。
2. Team Incoming Webhook Data Format
Team Incoming Webhook 是一個 RESTFul API,因此用戶必須使用以下格式發送數據。
{ "email":"jandi@tosslab.com", "body":"[休假設定完成]", "connectColor":"#FAC11B", "connectInfo":[ { "title":"2017年 10月 24日 休假申請審核完成", "description":"2017.10.24 ~ 2017.10.26 年假申請", "imageUrl":"http://www.jandi.com/image.jpg" }, { "title":"2017年 10月 24日 休假申請審核完成", "description":"2017.10.24 ~ 2017.10.26 年假申請 " } ] }
<JSON Object Field>
Field | Data Type | Description |
String | 連接到 JANDI 的個人電子郵件地址 | |
body | String | 最上面的訊息 |
connectColor | String | 訊息底部的欄位顏色 |
connectInfo | Object [ ] | 文本中訊息的排列 |
<connectInfo Object Field>
Field | Data Type | Description |
title | String | 訊息底部文本氣泡中的最上方訊息 |
description | String | 訊息底部文本氣泡中的中間訊息 |
imageUrl | String | 訊息底部文本氣泡中顯示的連結 URL |
3. Team Incoming Webhook Request
Webhook僅支援 HTTP POST Method
必須在請求中指定 Accept 和 Content-Type,如下所示。
Accept: application/vnd.tosslab.jandi-v2+json
Content-Type: application/json
另外請注意,如果存在2.Team Incoming WebhookData格式之外的字段,則忽略或返回錯誤。
curl \-X POST \https://wh.jandi.com/connect-api/team-webhook/279/7dbe00d0784c8cf1758f04d824510703 \-H 'Accept:application/vnd.tosslab.jandi-v2+json' \-H 'Content-Type:application/json' \--data-binary '{ "email":"jandi@tosslab.com", "body":"[休假設定完成]", "connectColor":"#FAC11B", "connectInfo":[ { "title":"2017年 10月 24日 休假申請審核完成.", "description":"2017.10.24 ~ 2017.10.26 연차 신청", "imageUrl":"http://www.jandi.com/image.jpg" }, { "title":"2017年 10月 24日 休假申請審核完成", "description":"2017.10.24 ~ 2017.10.26 연차 신청 " } ] }'
Response는 다음과 같습니다.
{ validEmails: [email1, email2, ...], // 發送Email地址 invalidEmails: [email1, email2, ...] // 發送Email地址}
99. Limit
- 60 requests / min
- 500 requests / 10 min
- 限制情況下的響應代碼: 429
如果您想使用如上所述向您的個人“Chat JANDI”發送訊息的“Team Incoming Webhook”,則交互工作按照手冊在內部完成。
請告訴我們的團隊您希望將什麼個人簡介圖片和名稱應用於團隊導入 Webhook。
Toss Lab 將發布 URL 申請所需的 Team ID 和 WebhookToken。
您可以將其輸入為 https://wh.jandi.com/connect-api/team-webhook/{Team ID}/{Token}\。
您可以通過 support@tosslab.com 或 JANDI 應用程序中的 [線上客服] 聯繫我們。
此功能僅適用於付費團隊。