JANDI Connect – Team Incoming Webhook 説明書
1. Team Incoming Webhookの概要
Incoming Webhookとは、外部データをJANDIで受信したいときに使われる機能のことです。しかし外部データを転送しようとすると、個々人が次のような手続きを行わなければなりません。
個々人がIncoming Webhookを作成し、作成されたURLを担当者に伝えます。担当者はURLと個人情報をマッチングさせて保存し、入退社または人事異動がある場合、すでにこれらのメンバーによって作成されてあるIncoming Webhookの登録および削除を行います。
上記の例のように、個々人がIncoming Webhookを作成すると、チーム単位での管理が難しくなります。これを解決するため、Team Incoming Webhookが開発されました。
管理者および所有者がTeam Incoming Webhookを一度作成し、作成されたURLにメッセージと共に個人識別者（JANDIアカウントに登録されたEメール）を転送すると個々人のメッセージ受信が可能になります。
これによって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に登録されている個人Eメール | |
body | String | 最上部に見えるメッセージ |
connectColor | String | メッセージ下部のバーの色 |
connectInfo | Object [ ] | メッセージ下部の吹き出しに見えるメッセージの配列 |
<connectInfo Object Field>
Field | Data Type | Description |
title | String | メッセージ下部の吹き出し内、最上行メッセージ |
description | String | メッセージ下部の吹き出し内、中間行メッセージ |
imageUrl | String | メッセージ下部の吹き出し内に見える Link URL |
3. Team Incoming Webhook Request
WebhookはHTTP POST Methodのみをサポートし、
Requestの際には必ずAcceptおよびContent-Typeを次のように指定する必要があります。
Accept: application/vnd.tosslab.jandi-v2+json
Content-Type: application/json
また、2. Team Incoming Webhook Data Formatに示されたField以外のFieldが存在する場合、Requestが反映されなかったり、またはエラーが表示されるのでご参考ください。
Eメールの有効性判断はいたしません。
curl \-X POST \https://wh.jandi.com/connect-api/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 有給休暇の申請 " } ] }'上記Requestが正常に受信された場合、JANDI上に見えるメッセージは下記イメージ例の通りになりますのでご参考ください。
<有給休暇の現況確認メッセージ>
上記のように個人‘チャットJANDI’へメッセージを送る'Team Incoming Webhook'をご利用になる場合、マニュアル通りに内部での連動作業を終え、
ex) https://wh.jandi.com/connect-api/webhook/{Team ID}/{Token}\
Team Incoming Webhookにアップロードするプロフィールイメージと名前を弊社チームまでお知らせください。
URLアップロードに必要なTeam ID、Webhook Tokenは弊社Toss Lab, Inc.で発行いたします。
support@tosslab.comまたはJANDIアプリケーション内[お問い合わせ]までお問い合わせください。