mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
72631830da
* Standardized values in the example configuration Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages) * Standardize example configuration-ecobee * Standardize example configuration-coinbase * Standardize example configuration-google assistant * Standardize example configuration-cloudflare * Standardize example configuration-cloudflare * Standardize example configuration-habitica * Standardize example configuration-ifttt * Standardize example configuration-openalpr * Standardize example configuration-multiple * Standardize example configuration-instapush * Standardize example configuration-llamalab * Standardize example configuration-notify * Standardize example configuration-mailgun * Standardize example configuration-MULTIPLE * Standardize example configuration-rtm * Standardize example configuration-spotcrime * Standardize example configuration-trafikverket * Standardize example configuration-uk transport * Standardize example configuration-wunderground * Standardize example configuration-wsdot * Standardize example configuration-telegram * Standardize example configuration-tts * Standardize example configuration-tts, vultr * Replace email entry * Replace IP address * Place email address
78 lines
2.4 KiB
Markdown
78 lines
2.4 KiB
Markdown
---
|
|
layout: page
|
|
title: "Pushover"
|
|
description: "Instructions on how to add Pushover notifications to Home Assistant."
|
|
date: 2015-01-20 22:36
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: pushover.png
|
|
ha_category: Notifications
|
|
ha_release: pre 0.7
|
|
---
|
|
|
|
|
|
The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard).
|
|
|
|
To use Pushover notifications, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: pushover
|
|
api_key: YOUR_API_KEY
|
|
user_key: YOUR_USER_KEY
|
|
```
|
|
|
|
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.
|
|
- **user_key** (*Required*): Your user key for Pushover.
|
|
|
|
Example Automation:
|
|
|
|
```yaml
|
|
- service: notify.entity_id
|
|
data:
|
|
message: "This is the message"
|
|
title: "Title of message"
|
|
data:
|
|
url: "https://www.home-assistant.io/"
|
|
sound: pianobar
|
|
priority: 0
|
|
```
|
|
|
|
Component specific values in the nested `data` section are optional.
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
|
|
|
When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api).
|
|
|
|
Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message:
|
|
|
|
{% raw %}
|
|
```yaml
|
|
# Example configuration.yaml entries
|
|
alexa:
|
|
intents:
|
|
LocateIntent:
|
|
action:
|
|
service: notify.notify
|
|
data_template:
|
|
message: "The location of {{ User }} has been queried via Alexa."
|
|
data:
|
|
title: "Home Assistant"
|
|
data:
|
|
sound: falling
|
|
device: pixel
|
|
url: "https://www.home-assistant.io/"
|
|
```
|
|
{% endraw %}
|