Team Incoming Webhook

Team Incoming Webhook

1. Team Incoming Webhook Outline

Incoming Webhook is a feature in JANDI that allows receiving external data. However, each users have to go through the following process to send external data.

Create Incoming Webhook individually, and send the generated URL to the manager. Then, the manager will compare the URL and personal information, save them, and manage to register or delete Incoming Webhook if there is any personnel shift such as employment, resignation or department transfer.

As you can see from the example above, once Incoming Webhook is created, it’s tricky to manage it as a Team. To solve this issue, we developed Team Incoming Webhook.

Personal messaging can be enabled when Admin or Owner sends personal identification(e-mail address registered to JANDI) with the message to the URL from Team Incoming Webhook(only generated once).

This can help JANDI users to freely connect with external servers, send group messages by work conditions through personal messaging feature which all together enables more extensive use of JANDI.

______Team_Incoming_Webhook_______________________2019-02-15_14-41-19__1_.png

 

2. Team Incoming Webhook Data Format

Team Incoming Webhook is a RESTFul API, so users must send data using the following format.

{
"email": "jandi@tosslab.com",
"body" : "[JANDI KIM’s vacation request approval]",
"connectColor" : "#FAC11B",
"connectInfo" : [
{
"title" : "Vacation request for Oct.24th, 2017 has been approved.",
"description" : "2017.10.24 ~ 2017.10.26 annual vacation request",
"imageUrl":"Url_to_text"
},
{
"title": " Vacation request for Oct.24th, 2017 has been approved.”,
"description": "2017.10.24 ~ 2017.10.26 annual vacation request "
}
]
}

 

<JSON ​Object ​Field> 

Field

Data ​Type

 Description

email

String

 Personal email address connected to JANDI

body

String

 Uppermost message

connectColor

String

​ Bar Color on the bottom of the message

connectInfo

Object  [  ​]

​ Arrangement of the messages in the text
 bubbles on the bottom of the message


<connectInfo ​Object ​Field>
 

Field

Data ​Type

 Description

title

String

 Uppermost message in the text bubble on the
 bottom of the message

description

String

​ Middle message in the text bubble on the
 bottom of the message

imageUrl

String

​ ​Link URL to be shown on the text bubble on the
 bottom of the message

 

3. Team Incoming Webhook Request

Webhook only supports HTTP POST Method, and in request, you must set up Accept and Content-Type as the following.

 

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

Content-Type: application/json

 

Also, please note that if there is another Field other than the ones stated on 2. Team Incoming Webhook Data Format, ignore or it will return an error.

It does not validate email address.

curl \

-X POST \

https://ws.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":"[JANDI KIM’s vacation request approval]]",
   "connectColor":"#FAC11B",
   "connectInfo":[  
      {  
         "title":"Vacation request for Oct.24th, 2017 has been approved.",
         "description":"2017.10.24 ~ 2017.10.26 annual vacation request",
         "imageUrl":"http://www.jandi.com/image.jpg"
      },
      {  
         "title":"Vacation request for Oct.24th, 2017 has been approved.",
         "description":"2017.10.24 ~ 2017.10.26 annual vacation request "
      }
   ]
}'

 

When Request is sent successfully, messages will appear in JANDI as the following.

______Team_Incoming_Webhook_______________________2019-02-15_14-41-19__1_.png

If you would like to use ‘Team Incoming Webhook’ that sends messages in personal ‘Chat JANDI’, please follow the steps in the Manual and let us know your name and the profile image you would like to use for your Team Incoming Webhook.

TossLab will provide your teamID and WebhookToken for your URL. Contact us by using Live Support or through email(support@tosslab.com).

Comments

Powered by Zendesk