What is Webbook?
A Webhook is a feature that JANDI receives a data that matches the default format set by JANDI itself and sends a message to the designated chat rooms. If a certain service is not supported by JANDI Connect, but supports Outgoing Webhook, it can connect with JANDI and receive a message on different updates.
* Tip : You can set up Webhook easily if you get help from developers or IT department.
STEP 1
Send an information (HTTP POST request) through a message to the Webhook URL generated in JANDI. You have to specify Accept and Content-Type in the request like the following:
Accept: application/vnd.tosslab.jandi-v2+json
Content-Type: application/json
Reference : JANDI Webhook works in restful API, so you have to set http method to POST. It will not work if you set it to other methods.
STEP 2
Format for POST request is as follows:
< POST request format>
{
"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"
}]
}
Each fields have the following functions.
“body” : Basic contents of the messages. If you write and send a message it will be received in a View. It is the only required entry and you cannot send a message with leaving this blank. If other fields are not provided, you can still send a message with this field only.
[[PizzaHouse]](http://url_to_text) – This is an example of the usage of Link Markdown(It is a text format that generates a hyperlink, and in JANDI, you can create a link like“[Text](Url Link)” that opens a new window when clicked) provided by JANDI.
“connectColor” : You can set the color attribute of attachment area on the bottom of the message with Hex Code.
“connectInfo” : It’s a field that lets you define what elements will be included in the attachment area.
“title” : It’s a title of the attachment area and it will be shown in ‘bold’.
“description” : It’s a detail of the attachment area. As you can see from the example above, you can add multiple titles and descriptions according to the structure of the message.
“imageUrl” If there is an image file attached to the Webhook message, you can attach it as a URL format. We will provide a thumbnail with the message later on.
Next is an example of the curl request. If you implement them in CLI, like Terminal, you can actually check receiving messages in JANDI.
Please do not forget to replace 'https://wh.jandi.com/connect-api/webhook/generated-link-in-JANDI' to actual Webhook address you generated in JANDI.
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"}]}'
Message received like this will be sent to the chat room that generated the Webhook as the following.
Tip!
Among the services you are using, even if they are supporting Webhook, you have to convert the events originating in the service to a certain format that JANDI can form as a message.
You can actually develop this process for this task, but you can use a third party service such as Zapier.
Maximum character counts for the message in JANDI is 5000 characters, and the maximum size of the data to receive through Webhook is 256kb. 256kb is sufficient enough to store 260 thousand characters, but if the data exceeds 256kb, it will return an error message.
If you send a message containing 250 thousand characters through Webhook, it will display 5000 characters maximum. If you send a message containing 270 thousand characters, it will not send the message itself at all.
If you have any more questions, please contact us by [Live Support].