Documentation
Notification Channels
Notification channels are endpoints where Leankoala can send events to. It is possible to send e-mails, slack messages to a channel or create your very own webhook.
To get information out of Leankoala it is also possible to use the export feature.
The e-mail notification channel is used to send e-mails in case of an incident. It is the most used channel in Leankoala.In order to personalize the subject and e-mail text, the Advanced Mode must be enabled in the Notification Channel area.
The e-mail addresses the alert should be sent to. It can be a single e-mail address or a comma separated List of more than one address.
Example
john.doe@example.com, erika.gabler@example.de
The subject of the e-mail can be customized to fit the recipient's needs. It is plain text that can be enriched with some predefined variables.
Best Practice
We prefer having the event status within the email subject because the message can be evaluated at first sight. On the other hand, it is possible to create e-mail filters for every status.
Example
Leankoala Alert: ${system_name} - ${event_status}
With Leankoala it is also possible to change the complete e-mail text of the e-mail alert customer-specific according to individual needs. The text has to be written in HTML and can be enriched with some predefined variables.
Example
Oh oh ... error in ${component.name}:
<br><br>
${event.message}
<br><br>
Please contact the tech team
<br><br>
${event.message}
<br><br>
Please contact the tech team
Slack is one of the most popular communication tools among tech companies. This is why Leankoala is able to create simple slack messages and send them via incoming webhook to slack.
The slack endpoint for this integration can be found here.
Best Practice
This feature is beta. The message format can still change.
The Microsoft Teams channel uses the standard "Incoming Webhook" collector that can be found in the Teams store. The only thing Leankoala needs is the webhook URL provides by the collector.
in most cases it email and slack channels are sufficient. If not it is possible to build your very own endpoint called a webhook. It is described by an URL Leankoala should send the incidents data to. The format of the data is JSON and looks like:
{
"identifier":"<the event identifer>",
"system":"<the system identifier>",
"systemName":"<the system name>",
"component":"<the component identifier>",
"componentName":"<the component name>",
"status":"<the status>",
"message":"<the message>",
"type":"<the name of the tool sending the event>",
"value":<an integer value>,
"directLink":"<link to the dashboard>"
}
"identifier":"<the event identifer>",
"system":"<the system identifier>",
"systemName":"<the system name>",
"component":"<the component identifier>",
"componentName":"<the component name>",
"status":"<the status>",
"message":"<the message>",
"type":"<the name of the tool sending the event>",
"value":<an integer value>,
"directLink":"<link to the dashboard>"
}
For everybody new to webhooks the page webhook.site is recommended. it will show the incoming webhook in detail with all headers and content.