From 6b79ab6388421429fa04477e6bc2b0a4e43b9273 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 13 Oct 2015 22:45:59 +0200 Subject: [PATCH] Add variables description --- source/components/notify.slack.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/source/components/notify.slack.markdown b/source/components/notify.slack.markdown index 3139cb46f79..cb4078e3e68 100644 --- a/source/components/notify.slack.markdown +++ b/source/components/notify.slack.markdown @@ -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). +