Send Pushbullet™ test with access token

This function uses the specified access token to send a test Pushbullet™ note. The function automatically generates a message title and body, and it includes a unique string in the test message. When the test message returns, the system searches for the ID string and returns it.

If the function does not detect the correct ID string in the returned message, the function fails. You can also review the user's Pushbullet channel history to confirm that the server sent and received the message.

The test's success or failure depends on various conditions. For example:

  • Valid access token.
  • Network configuration.
  • Service outages.
  • External server rate limit.
Authorizations:
query Parameters
access_token
required
string

The Pushbullet token to use.

Note:

  • To access your Pushbullet token, navigate to Pushbullet's My Account page. It will appear under the Access Token heading.
  • This is confidential information that your server sends via a secure channel.
Example: access_token=a1b2c3d4e5f6g7h8i9j0

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  send_test_pushbullet_note \
  access_token='a1b2c3d4e5f6g7h8i9j0'

Response samples

Content type
application/json
{
  • "data": {
    • "message_id": "554d2cbd-efe61da3cacb",
    • "payload": {
      • "active": true,
      • "body": "This message confirms that \"hostname.example.com\" (192.168.0.20) can send a message to you via Pushbullet.\n\nThis message was sent on Monday, May 18, 2015 at 7:12:20 PM UTC.",
      • "created": 1431976341.38872,
      • "direction": "self",
      • "dismissed": false,
      • "iden": "ujw5ScArtjUsjAeRXXMLGS",
      • "modifiedx": 1431976341.39182,
      • "receiver_email": "user@example.com",
      • "receiver_email_normalized": "user@example.com",
      • "receiver_iden": "ujw5ScArtjU",
      • "sender_email": "user@example.com",
      • "sender_email_normalized": "user@example.com",
      • "sender_iden": "ujw5ScArtjU",
      • "sender_name": "Firstname Lastname",
      • "title": "Test message (ID: 555a3994-173a4a271062d)",
      • "type": "note"
      }
    },
  • "metadata": {
    • "command": "send_test_pushbullet_note",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}