jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update pushetta notify component configuration (#7530)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-16 08:57:40 +01:00 committed by Fabian Affolter
parent a15df464ad
commit 966e8de8a5
1 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
source/_components/notify.pushetta.markdown
View File

@ -12,7 +12,6 @@ ha_category: Notifications
ha_release: pre 0.7
---
The `pushetta` notify platform uses [Pushetta](http://www.pushetta.com) to delivery notifications from Home Assistant to your devices.
To retrieve the API token, log into your account at [http://www.pushetta.com](http://www.pushetta.com) and go to your **Dashboard**. Create a new channel by clicking on **Channels** and then **Add a Channel**.
@ -28,21 +27,35 @@ notify:
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.
- **send_test_msg** (*Optional*): Disable/enable the test message send on Home Assistant's startup to test the API key and the existence of the channel. Default to `False`.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
api_key:
description: Your API key for Pushetta.
required: true
type: string
channel_name:
description: The name of your channel.
required: true
type: string
send_test_msg:
description: Disable/enable the test message send on Home Assistant's startup to test the API key and the existence of the channel.
required: false
default: false
type: boolean
{% endconfiguration %}
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/
-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/).