Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Channel web hooks allows the to post any content to a channel or create cases in channel. Channel web hooks are created in channel properties.

...

After web hook is created you can post JSON data to create a new activity on channel. Web hook URL contains required all the required information and does not need any authentication.

...

When JSON data contains a "id" property, web hook creates a new case instead of a just posting a message. Id field must be unique for channel or otherwise web hook ignores message and returns already reported.

Code Block
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",
    "attachment" : [
    {
        "@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 create creates a new case and attach attaches the message to the case.

Updating a Case

Web hooks also supports the to receive 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 a an update message.