home-assistant.io/source/_components/notify.pushbullet.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

3.1 KiB

layout title description date sidebar comments sharing footer logo ha_category featured
page Pushbullet Instructions on how to add user notifications to Home Assistant. 2015-01-20 22:36 true false true true pushbullet.png Notifications true

The pushbullet notification platform sends messages to Pushbullet, a free service to send information between your phones, browsers, and friends.

To enable Pushbullet notifications in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: pushbullet
    api_key: YOUR_API_KEY

Configuration variables:

  • api_key (Required): Enter the API key for Pushbullet. Go to https://www.pushbullet.com/#settings/account to retrieve your API key/access token.
  • 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.

{% linkable_title Usage %}

Pushbullet is a notify platform and thus can be controlled by calling the notify service as described here. It will send a notification to all devices registered in the Pushbullet account. An optional target parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.

Type Prefix Suffix Example
Device device/ Device nickname device/iphone
Channel channel/ Channel tag channel/my_home
Email email/ Contact's email address email/email@example.com

If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.

{% linkable_title Example service payload %}

{
  "message": "A message for many people",
  "target": [
    "device/telephone",
    "email/hello@example.com",
    "channel/my_home"
  ]
}

To use notifications, please see the getting started with automation page.

{% linkable_title URL support %}

action:
  service: notify.NOTIFIER_NAME
  data:
    title: Send URL
    message: This is an url
    data:
      url: google.com
  • url (Required): Page URL to send with Pushbullet.

{% linkable_title File support %}

action:
  service: notify.NOTIFIER_NAME
  data:
    title: Send file
    message: This is a file
    data:
      file: /path/to/my/file
  • file (Required): File to send with Pushbullet.

{% linkable_title File URL support %}

action:
  service: notify.NOTIFIER_NAME
  data:
    title: Send file
    message: This is a file URL
    data:
      file_url:  https://cdn.pixabay.com/photo/2014/06/03/19/38/test-361512_960_720.jpg
  • file_url (Required): File to send with Pushbullet.

Don't forget to [whitelist external directories](/docs/configuration/basic/), so Home Assistant has access to them.