From df552937481c27b64de463efd0eda219cf3f14c8 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 13 Oct 2015 23:13:21 +0200 Subject: [PATCH] Add variables description --- source/components/notify.instapush.markdown | 23 ++++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/source/components/notify.instapush.markdown b/source/components/notify.instapush.markdown index d4afc2802e6..97d257f08a7 100644 --- a/source/components/notify.instapush.markdown +++ b/source/components/notify.instapush.markdown @@ -17,18 +17,21 @@ The Instapush [Getting Started page](https://instapush.im/home/start/) will guid ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME - platform: instapush - # Get those by creating a new application, event, and tracker on https://instapush.im - api_key: ABCDEFGHJKLMNOPQRSTUVXYZ - app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ - event: ABCDEFGHJKLMNOPQRSTUVXYZ - tracker: ABCDEFGHJKLMNOPQRSTUVXYZ + name: NOTIFIER_NAME + platform: instapush + api_key: ABCDEFGHJKLMNOPQRSTUVXYZ + app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ + event: ABCDEFGHJKLMNOPQRSTUVXYZ + tracker: ABCDEFGHJKLMNOPQRSTUVXYZ ``` -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*): Your API key for Instapush. +- **app_secret** (*Required*): The secret for your created application. +- **event** (*Required*): TThe event +- **tracker** (*Required*): The name of tracker inside Instapush. To retrieve those values for existing settings, log into your account at https://instapush.im and go to your **Dashboard**. Then click **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the ``api_key`` and ``app_secret`` is the *Application Secret*.