Skip to content
 
 

Repository files navigation

Push Notifications

Forward notifications to your phone or other devices, currently supports Pushbullet, Pushover, Pushcut and Gotify.

Testing

You can test out your integrations by typing ::sendpush in the chatbox. This will trigger a fake notification event.

Integrations

Pushbullet

You need to provide a pushbullet api key to use this service. Go here and click create new token or use your existing one. create-new-pushbullet

The generated key will be in the format o.Dorf43jdDIepfKeroPewfjeIUHJ4MrOP.

Open your client and paste the key into the Pushbullet config field of Push Notifications to enable phone notifications.

Pushover

You need to provide both a pushover user key and api token to use this service.

Go here, login and your user key will be in the top right of the page.

To get an api key, click Create an Application/API Token, enter a name for the application such as Runelite and click Create Application.

create-new-pushover

Your api key will then be displayed at the top of the page.

Copy and paste both the user key and api token into there respective fields under the Pushover section to enable notifications.

Pushcut

Pushcut is a notification service on iOS, that offers the ability to add triggers to notifications. Meaning, you can trigger an iOS shortcut or open a URL (including deeplinks) by tapping or acknowledging the notification on your device.

You need to provide the following:

  • Webhook Secret: This is automatically created when creating an account. Locate your secret within the Pushcut app by navigating to account -> webhook -> secret
  • Notification Name: The name for a notification that you create within the app

NOTE: Both Webhook Secret, and Notification Name are CASE SENSITIVE.

Gotify

Gotify is a self-hosted push notification service.

You need to provide a Gotify server URL, application token and priority.

Gotify server URL format: http://10.0.0.30:8080/message

Gotify token can be created under Apps/Create Application

create-new-gotify

Example notification

example-gotify

Triggering a push notification

The easiest way to trigger a push notification is to use the standard notification api: notifier.notify("notification text"), the notification text will be forwarded to the configured services.

There is also the option to send a PluginMessage with namespace push-notifications and name notify. This will forward the value of $.message.

Watchdog

Within watchdog, configure a notification of type "Plugin Message" with the namespace push-notifications and method notify.

example-create-watchdog

Add the message data as a JSON message:

{"message": "test from watchdog"}

example-create-watchdog-1

Test the alert from within watchdog using the potion icon.

example-pushover-watchdog

About

External plugins for RuneLite

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors