home-assistant.github.io/source/components/notify.instapush.markdown
2015-10-13 23:13:21 +02:00

2.2 KiB

layout title description date sidebar comments sharing footer
page Instapush notification support Instructions how to add Instapush notifications to Home Assistant. 2015-05-01 18:00 false false true true
The instapush platform uses [Instapush](https://instapush.im) to delivery notifications from Home Assistant to your Android or iOS device.

The Instapush Getting Started page will guide through the process of creating the required items.

# Example configuration.yaml entry
notify:
  name: NOTIFIER_NAME
  platform: instapush
  api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
  app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
  event: ABCDEFGHJKLMNOPQRSTUVXYZ
  tracker: ABCDEFGHJKLMNOPQRSTUVXYZ

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.

It's easy to test your Instapush setup outside of Home Assistant. Assuming you have an event notification and a tracker home-assistant, just fire a request and check the Instapush dashboard for a new entry.

curl -X POST \
    -H "x-instapush-appid: YOUR_APP_KEY" \
    -H "x-instapush-appsecret: YOUR_APP_SECRET" \
    -H "Content-Type: application/json" \
      -d '{"event":"notification","trackers":{"home-assistant":"Switch 1"}}' \
    https://api.instapush.im/v1/post

For further details, please check the API.

To use notifications, please see the getting started with automation page.