alerta-contrib/plugins/slack/README.md
2016-11-08 14:08:48 +02:00

42 lines
1 KiB
Markdown

Slack Plugin
============
Send alerts to [Slack](https://slack.com/).
![Slack Message](./images/alerta-slack-plugin.png)
Installation
------------
Run the following command on the Alerta server to install and register the new plugin:
$ python setup.py install
Configuration
-------------
To configure the Slack plugin start by setting up an
[incoming webhook integration](https://my.slack.com/services/new/incoming-webhook/)
for your Slack channel and adding the following configuration settings to `alertad.conf`:
```
SLACK_WEBHOOK_URL = 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
SLACK_ATTACHMENTS = True # default=False
SLACK_CHANNEL = '' # if empty then uses channel from incoming webhook configuration
ALERTA_UI_URL = 'http://your.alerta.ui.url'
ICON_EMOJI = '' # default :rocket:
ALERTA_USERNAME = '' # default alerta
```
Lastly, add `slack` to the list of enabled plugins:
```
PLUGINS = ['reject', 'slack']
```
References
----------
Slack Incoming Webhooks: https://api.slack.com/incoming-webhooks