Pushover integration Documentation - ilpersi/BHBot GitHub Wiki

Pushover documentation

What is Pushover?

In short, Pushover is a service to receive instant push notifications on your phone or tablet from a variety of sources.

Is Pushover free?

Short answer: NO.

Long answer: after a 7-day free trial, it costs $4.99 USD once, per-platform (iOS, Android, Desktop). For better details please refer to the official Pushover documentation.

Please note that the BHBot development team is not in anyway related or affiliated with the Pushover one and that the Pushover integration is an optional feature.

How do I use Pushover with BHBot?

To get started:

  1. Install the client app on your iPhone/iPad/iPod Touch or Android device, or register your Desktop browser.
  2. Launch the client and it will walk you through creating a Pushover account and registering your device with their servers.
  3. You'll get a new User Key e-mailed to you (which that is also available in the Pushover dashboard or through the Settings menu of the Pushover client app on your device). Your User Key is a randomly generated identifier which allows BHBot to send Pushover notifications to your devices. You have to use this key in the settings.ini poUserToken parameter.
  4. Create a new application from here and once you are done get the API Token/Key for it and use it in the settings.ini poAppToken parameter.

How do I check if the configuration is correct?

Starting from v34.1 you can use the pomessage command to send a test message. This command will also print output the following information taken from your settings.ini:

  • poUserToken
  • poAppToken

In the picture below you can see that:

  • poUserToken starts with "uoL4"
  • poAppToken starts with "a7wab"

RCCwgJb3Jg.png

poUserToken double check

To double check the poUserToken head to your Pushover dashboard and verify your User key. As you can see from the picture below it matches with what is printed from the pomessage command (they both start with "uoL4").

HyO6aAWoId.png

poAppToken double check

To verify the poAppToken from the dashboard open the details of the application that you previously created and check the API Token/Key. As you can see from the picture below it matches with what is printed from the pomessage command (they both start with "a7wab").

5gFqdlPQrZ.png

What can be notified with Pushover

The following settings.ini parameters are available to manage the Pushover integration

  • enablePushover 1 to enable the Pushover integration, 0 to disable it
  • poAppToken Pushover APP_TOKEN
  • poUserToken Pushover USER_TOKEN
  • poNotifyCrash 1 to be notified about crashes, 0 to disable crash notifications
  • poNotifyErrors 1 to be notified about errors, 0 to disable errors notifications
  • poNotifyAlive Keep alive notification to be triggered every n hours, set to 0 to disable keep alive notifications
  • poNotifyPM 1 to be notified about PM, 0 to disable PM notifications
  • poNotifyBribe 1 to be notified of bribe attempts, 0 to disable bribe notifications