Description
The SlackRecipient component is used to send a notification to a Slack channel when an alarm is triggered. Slack is a cloud-based set of team collaboration tools and services.
Implementation
You can follow this tutorial that goes through the different steps: SlackRecipient Tutorial
Niagara Component:
Example of notification received in Slack
Example of a popup on Slack when the user clicks on the Details button. Some tags can appear at the bottom.
Properties
- AlarmRecipient: The SlackRecipient has the same common properties than a ConsoleRecipient or an AlarmEmailRecipient.
- Token: Legacy Token you need to get from https://api.slack.com/custom-integrations/legacy-tokens in the "Legacy token generator" section (you have to be logged to your workspace first). You can follow this tutorial SlackRecipient Tutorial
This token is associated with your account and with a Workspace. You will only be able to write in public channels and private channels of this Workspace where you have "write" rights.
- Channel Id: The channel where you want to send notifications. Here's how to get it https://www.wikihow.com/Find-a-Channel-ID-on-Slack-on-PC-or-Mac.
- Optionnal Alarm Data: Additional information you want to provide to Slack notifications for each processed alarm. This information must be taken from the "alarmData" field of an alarm record (Additional information you can set from the metadata slot in an alarm extension or if you use btibStructure). Enter the names separated by semicolons. Example: building;floor;hyperlinkOrd
Be careful, the text in the popup is limited to 280 characters.
- BotName: The bot name displayed in the notification.
- BotIconUrl: The url to the image which will be associated to the bot. It has to be an online resource.
The image must be square and its size must be between 512x512 and 2000x2000 pixels.
Actions
- Route: Action to link from alarm classes.
Tutorials
- See this tutorial: SlackRecipient Tutorial