Documentation

pushbullet - Sends notifications to Pushbullet

New in version 2.0.

Synopsis

This module sends push notifications via Pushbullet to channels or devices.

Requirements (on host that executes module)

  • pushbullet.py

Options

parameter required default choices comments
api_key
 yes
    Push bullet API token
    body
    		 no
      Body of the notification, e.g. Details of the fault you're alerting.
      channel
      		 no
        The channel TAG you wish to broadcast a push notification, as seen on the "My Channels" > "Edit your channel" at Pushbullet page.
        device
        		 no
          The device NAME you wish to send a push notification, as seen on the Pushbullet main page.
          push_type
          		 no note
          • note
          • link
          Thing you wish to push.
          title
          		 yes
            Title of the notification.

            Examples

            # Sends a push notification to a device
- pushbullet:
    api_key: "ABC123abc123ABC123abc123ABC123ab"
    device: "Chrome"
    title: "You may see this on Google Chrome"

# Sends a link to a device
- pushbullet:
    api_key: "ABC123abc123ABC123abc123ABC123ab"
    device: "Chrome"
    push_type: "link"
    title: "Ansible Documentation"
    body: "http://docs.ansible.com/"

# Sends a push notification to a channel
- pushbullet:
    api_key: "ABC123abc123ABC123abc123ABC123ab"
    channel: "my-awesome-channel"
    title: "Broadcasting a message to the #my-awesome-channel folks"

# Sends a push notification with title and body to a channel
- pushbullet:
    api_key: "ABC123abc123ABC123abc123ABC123ab"
    channel: "my-awesome-channel"
    title: "ALERT! Signup service is down"
    body: "Error rate on signup service is over 90% for more than 2 minutes"

            Notes

            Note

            Requires pushbullet.py Python package on the remote host. You can install it via pip with ($ pip install pushbullet.py). See https://github.com/randomchars/pushbullet.py

            This is an Extras Module

            For more information on what this means please read Extras Modules

            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.