Channel Web Hooks
Channel web hooks allows to post any content to a channel or create cases in channel. Channel web hooks are created in channel properties.
Creating a New Web Hook
To create a new web hook please follow these steps;
Open a channel where you want to create a web hook
Select "Edit" from the channel menu
Switch to the "Web Hooks" tabs and click on to "Add New" button
Web hook URL is automatically generated, enter the purpose of the channel
Click the "Copy" button next to the Url field to copy Url to the clipboard.
Click Ok to save changes.
Posting Channel Activity
After the web hook is created you can post JSON data to create a new activity on the channel. Web hook URL contains all the required information and does not need any authentication.
Posting Basic Message
POST /hooks/channels/f923d83a-3350-42d0-b9cb-620032730294/8459b574-62ea-4ea7-bbae-a132fbfee5df
Host: my.emakin.com
Content-Type: application/json
{
"text" : "my message"
}
Posting Message with Attachments
As another example, you can post the following JSON to send a message with attachments.
POST /hooks/channels/f923d83a-3350-42d0-b9cb-620032730294/8459b574-62ea-4ea7-bbae-a132fbfee5df
Host: my.emakin.com
Content-Type: application/json
{
"text" : "my message",
"attachments" : [
{
"@type": "file",
"displayName": "my file",
"ext": "txt",
"url": "http://myserver/myfile"
},
{
"@type": "link",
"url": "http://www.google.com",
"displayName": "http://www.google.com"
}]
}
Creating a New Case In Channel
When JSON data contains an "id" property, web hook creates a new case instead of just posting a message. Id field must be unique for the channel or otherwise, the web hook ignores the message and returns the already reported status.
POST /hooks/channels/f923d83a-3350-42d0-b9cb-620032730294/8459b574-62ea-4ea7-bbae-a132fbfee5df
Host: my.emakin.com
Content-Type: application/json
{
"id" : "event1",
"text" : "my message",
"attachments" : [
{
"@type": "file",
"displayName": "my file",
"ext": "txt",
"url": "http://myserver/myfile"
},
{
"@type": "link",
"url": "http://www.google.com",
"displayName": "http://www.google.com"
}]
}
JSON with "id" property automatically creates a new case and attaches the message to the case.
Updating a Case
Web hooks also support receiving notifications about previously posted messages.
To post a new update message to an existing case, JSON data must contain a "references" property that contains the previously reported message id.
JSON with "references" automatically appends a new message to an existing case as an update message.
Copyright © 2010 - 2023 Emakin. All rights reserved.