mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 22:06:50 +00:00
Add docs for Prowl. (#3194)
* Add docs for Prowl. * Update 'ha_release'
This commit is contained in:
parent
8a785eabb2
commit
13f1a804f1
43
source/_components/notify.prowl.markdown
Normal file
43
source/_components/notify.prowl.markdown
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Prowl"
|
||||
description: "Instructions how to add Prowl notifications to Home Assistant."
|
||||
date: 2017-08-17 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: prowl.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.52
|
||||
---
|
||||
|
||||
|
||||
The `prowl` platform uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
|
||||
|
||||
Go to the [Prowl website](https://www.prowlapp.com/) and create a new API key.
|
||||
|
||||
To add Prowl notifications to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: prowl
|
||||
api_key: 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*): The Prowl API key to use.
|
||||
|
||||
### {% linkable_title Prowl service data %}
|
||||
|
||||
The following attributes can be placed `data` for extended functionality.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `priority` | yes | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
BIN
source/images/supported_brands/prowl.png
Normal file
BIN
source/images/supported_brands/prowl.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 29 KiB |
Loading…
x
Reference in New Issue
Block a user