Add variables description

This commit is contained in:
Fabian Affolter 2015-10-13 22:45:59 +02:00
parent c943e8de69
commit 6b79ab6388

View File

@ -25,6 +25,11 @@ notify:
default_channel: '#general'
```
Setting the optional parameter `name` allows multiple notifiers to be created.
The default value is `notify`. The notifier will bind to the service
`notify.NOTIFIER_NAME`.
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **api_key** (*Required*): The slack API token to use for sending slack messages. You can get your slack API token here https://api.slack.com/web?sudo=1
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation.html).