home-assistant.io/source/components/notify.instapush.markdown
Ryan Kraus 0b4c6b188b Updated notifier documentation.
1) Added missing notifiers to general notifier page and rearranged
notifiers to be in alphabetical order.
2) Added documentation about new name property for notifiers and how it
works into the service call.
2015-08-19 23:54:10 -04:00

2.0 KiB

layout, title, description, date, sidebar, comments, sharing, footer
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
    # Get those by creating a new application, event, and tracker on https://instapush.im
    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.

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.