home-assistant.io/source/_components/notify.pushover.markdown
Franck Nijhof a9569af0a4 Revert "Add example file attachment parameters (#5134)"
This reverts commit e3c6e65f19633b3292d64e1f80c4902fe3ee8d32.
2018-04-10 20:06:45 +02:00

2.4 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page Pushover Instructions on how to add Pushover notifications to Home Assistant. 2015-01-20 22:36 true false true true pushover.png Notifications pre 0.7

The Pushover service 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 on the Pushover website. Your Pushover user key can be found on the Pushover dashboard.

To use Pushover notifications, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: pushover
    api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
    user_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): Your API key.
  • user_key (Required): Your user key for Pushover.

Example Automation:

- 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.

When sending a notification, optional parameters can also be set as per the pushover API documentation.

Example notification triggered from the Alexa component for an intents is shown below which also uses Automation Templating for the message:

{% raw %}

# 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 %}