Prerequisites
Pushbullet account
Create a free account at pushbullet.com.
API key
Generate an access token from Settings → Account in the Pushbullet web app.
Installation
The Pushbullet integration requires two additional packages:pushbullet.py and ws4py. Install them with the Pushbullet extra:
pushbullet.py>=0.11.0 and ws4py>=0.4.2.
Configuration
Add the following to yourpai.conf:
pai.conf
Configuration reference
PUSHBULLET_ENABLE
PUSHBULLET_ENABLE
Enable or disable the Pushbullet interface. Set to
True to activate.Default: FalsePUSHBULLET_KEY
PUSHBULLET_KEY
Your Pushbullet API access token. Generate it from Settings → Account on the Pushbullet website.Default:
''PUSHBULLET_DEVICE
PUSHBULLET_DEVICE
The nickname of the Pushbullet device that PAI registers and sends notifications from. If a device with this name does not exist, PAI creates one automatically with icon
system.Default: 'pai'PUSHBULLET_CONTACTS
PUSHBULLET_CONTACTS
A list of Pushbullet user email addresses that are allowed to send commands to the panel and receive notifications. Messages from email addresses not in this list are logged as unknown and ignored.Default:
[]PUSHBULLET_MIN_EVENT_LEVEL
PUSHBULLET_MIN_EVENT_LEVEL
The minimum severity level for events to be forwarded. Accepted values:
DEBUG, INFO, WARN, ERROR, CRITICAL.Default: 'INFO'PUSHBULLET_EVENT_FILTERS
PUSHBULLET_EVENT_FILTERS
A list of tag expressions that control which events are sent. Each entry is a comma-separated list of tags; a
- prefix excludes a tag. An event matches if all tags in any one expression match. This option cannot be combined with PUSHBULLET_ALLOW_EVENTS.Default:PUSHBULLET_ALLOW_EVENTS and PUSHBULLET_IGNORE_EVENTS
PUSHBULLET_ALLOW_EVENTS and PUSHBULLET_IGNORE_EVENTS
Alternative to Default:
PUSHBULLET_EVENT_FILTERS using regular expressions.PUSHBULLET_ALLOW_EVENTS— list of regex patterns matchingtype,label,property=valuefor events to forward.PUSHBULLET_IGNORE_EVENTS— list of regex patterns for events to suppress, applied afterALLOW_EVENTS.
[] for bothExample configuration
How event filtering works
PAI applies event filters before sending a notification. You can use one of two mutually exclusive approaches:- Tag filters (PUSHBULLET_EVENT_FILTERS)
- Regex filters (PUSHBULLET_ALLOW_EVENTS / PUSHBULLET_IGNORE_EVENTS)
Each entry in
PUSHBULLET_EVENT_FILTERS is a comma-separated list of tags. A - prefix means the tag must not be present. An event is forwarded if it matches all tags in any one filter entry.