Home Assistant Home Assistant

Pushover

The Pushover service is a platform for the notify component. This allows integrations to send messages to the user using Pushover.

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: YOUR_API_KEY
    user_key: YOUR_USER_KEY

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.

api_key string Required

Your API key.

user_key string 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
          attachment: "http://example.com/image.png"

Component specific values in the nested data section are optional.

Image attachments can be added using the attachment parameter, which can either be a valid URL for an image (ex: http://example.com/image.png) or a local file reference (ex: /tmp/image.png).

To use a specific Pushover device, set it using target. If one of the entered devices doesn’t exist or is disabled in your Pushover account it will send a message to all you devices. To send to all devices, just skip the target attribute.

- service: notify.entity_id
      data:
        message: "This is the message"
        title: "Title of message"
        target:
          - pixel3
          - pixel4a
        data:
          sound: pianobar
          priority: 0

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 integration for an intents is shown below which also uses Automation Templating for the message:

# Example configuration.yaml entries
alexa:
  intents:
    LocateIntent:
      action:
        service: notify.notify
        data:
          message: "The location of {{ User }} has been queried via Alexa."
        data:
          title: "Home Assistant"
          target: pixel
          data:
            sound: falling
            url: "https://www.home-assistant.io/"
            attachment: "/tmp/image.png"