Add pushetta docs

This commit is contained in:
Fabian Affolter 2015-11-10 14:13:05 +01:00
parent 71fffc07f4
commit f7cafa7f09

View File

@ -0,0 +1,48 @@
---
layout: component
title: "Pushetta"
description: "Instructions how to add Pushetta notifications to Home Assistant."
date: 2015-11-10 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: pushetta.png
ha_category: Notifications
---
The pushetta platform uses [Pushetta](http://www.pushetta.com) to delivery notifications from Home Assistant to your devices.
To enable Pushetta notifications in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: pushetta
api_key: YOUR_API_KEY
channel_name: YOUR_CHANNEL_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 Pushetta.
- **channel_name** (*Required*): The name of your channel.
To retrieve the API token, log into your account at http://www.pushetta.com and go to your **Dashboard**. Create a new channel by clicking on **Channels** and then **Add a Channel**.
It's easy to test your Pushetta setup outside of Home Assistant. Assuming you have a channel *home-assistant*, just fire a request and check the channel page in the dashboard for a new message.
```bash
curl -X POST \
-H "Authorization: Token YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{ \"body\" : \"Hello World\", \"message_type\" : \"text/plain\" }" \
http://api.pushetta.com/api/pushes/home-assistant/
```
For further details, please check the [API](http://pushetta.com/pushetta-api/).
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation/).