This page is part of archived documentation for openHAB 2.5. Go to the current stable version
# Pushbullet Actions v1
The Pushbullet action allows you to notify iOS, Android & Windows 10 Phone & Desktop devices of a message using the Pushbullet API web service.
# Configuration
You may define default values for parameters to action calls in the file services/pushbullet.cfg.
To override the default values, specify configuration parameters in the action call (using Action override).
| Property | Default | Required | Action override | Description |
|---|---|---|---|---|
| accesstoken | Yes | - | Pushbullet API token to send to devices | |
| devicename | DEFAULT | No | botname | The name of the openHAB bot |
| defaultreceiver | No | receiver | The name of the Recipient | |
| bots | No | - | Comma-separated list of multiple bots, each with its own settings below. | |
<bot>.devicename | Yes, if using multiple bots | botname | Device name for a single bot | |
<bot>.accesstoken | Yes, if using multiple bots | - | API token for a single bot |
# Example Configurations
Minimal (required):
accesstoken=<API token>
Extended setup with 2 bots, each with its own access token (optional):
bots=bot1,bot2
bot1.devicename=openHAB-foobar
bot1.accesstoken=1234abc
bot2.devicename=openHAB-tralala
bot2.accesstoken=4711qwert
# Actions
The following is a valid action call that can be made when the plugin is loaded. For specific information on each item, see the Pushbullet API (opens new window). The recipient can either be an email address or a channel tag. If it is not specified or invalid, the note will be broadcast to all of the user account's devices.
sendPushbulletNote(String title, String message)sendPushbulletNote(String receiver, String title, String message)sendPushbulletNote(String botname, String receiver, String title, String message)
# Examples
sendPushbulletNote("mybot", "[email protected]", "this is the title", "And this is the body of the message")
# Creating an account for your bot(s)
The pushbullet accounts are bound to either Google or Facebook accounts.
- Go to "https://www.pushbullet.com/ (opens new window)"
- Chose to either "Sign up with Google" or "Sign up with Facebook".
- Complete the signup process as guided by the pushbullet web site.
- Continue with "Obtaining an API key".
# Obtaining an API key
The API keys are bound to the pushbullet account.
- Go to the pushbullet site.
- Log in with either your personal account or the one you created for your bot.
- Go to "https://www.pushbullet.com/#settings/account (opens new window)"
- Click on "Create Access Token".
- Copy the token created on the site.
You must at least provide an API token (Private or Alias Key from Pushbullet.com (opens new window)) and a message in some manner before a message can be pushed. All other parameters are optional. If you use an alias key, the parameters (device, icon, sound, vibration) are overwritten by the alias setting on pushbullet.
# Rate limits
Free accounts have a limit of 100 pushes per month. This action does not evaluate the rate limiting headers though.
# Libraries
This action has been written without using libraries as jpushbullet or jpushbullet2. Both of those libraries use various libraries themselves which makes integrating them into openHAB a challenge.
# pushbullet API
- https://docs.pushbullet.com/ (opens new window)
- https://docs.pushbullet.com/#push-limit (opens new window)