Notification Plugins

On top of email notifications, you also have the option to install and activate additional notification plugins to integrate with JetBackup, allowing you to send JetBackup notifications via other third-party messaging applications. Below is a list of notification plugins available by default and instructions on how to setup each.

Natively Supported Notification Plugins:

Slack

slack example

Create a Slack App

  1. Visit https://api.slack.com/ and sign-in to your Slack Workspace to create a new app. Specify the name for your app and choose the Slack Workspace where the notification will be sent.

slack1

  1. Under the "Add features and functionality" section, click on "Permissions" .

slack2

  1. Scroll down to "Scopes: Bot Token Scopes", click on "Add an OAuth Scope" and apply the following permissions:
  • channles:read
  • channels:join
  • chat:write

slack3

  1. Click on "Install App to Workspace" then authorize the permissions you have specified for the app.

slack4

Slack will then generate a "Bot User OAuth Access Token". Take note of this token as it will be required to authorize the Slack Plugin in JetBackup.

slack6

Install and Activate the Slack Plugin

Once you have your Slack App configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

  1. On the Slack Notification Plugin, click "Install" then hit "Activate"
  2. On the Slack Notification Integration window, configure the following available options:
    • Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
    • Specify the Slack Channel Name you would like to receive the JetBackup notifications to.
    • Enter the Bot User OAuth Access Token generated in your Slack App then hit "Enable".

slack7

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the channel you specified on the plugin, and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Slack.

slack success


Syslog

Syslog is used for logging and tracking system messages in the Linux environment. This service constitutes the system log daemon (syslogd), where any program can do its logging in addition to kernel messages.

To Enable this plugin, navigate to Notification Settings (Settings > Notification). On the Syslog Notification Plugin, click "Install" then hit "Activate"

On the Slack Notification Integration window, configure the Notification Alert Levels and the frequency you would like to send your notifications to Slack then hit "Enable". For more information about alert types, please visit Alerts.

syslog1

Once successfully activated, JetBackup will now be able to send notifications to /var/log/messages via syslog.

syslog2



Google Hangouts

Configure a JetBackup Google Bot

Visit your Google Developer Console and sign in with your GSuite Account.

On the search box, look for "Hangouts Chat API" and click "ENABLE".

google hangouts 1

Once enabled, navigate to "Credentials", click "+ CREATE CREDENTIALS" and select "Service Account".

google hangouts 2

Fill in the necessary information and hit "CREATE". The setup will then ask for optional account and user access permissions which you can skip.

google hangouts 3

After setting up your JetBackup Bot Service Account, click on the ellipsis icon under the Actions column and click "Manage keys".

google hangouts 4a

On the next page, click "ADD KEY" > "Create new key".

google hangouts 4b

Choose JSON for the Key type and hit "CREATE". This will download a JSON File which you will use to authenticate the Google Hangouts Plugin in JetBackup.

google hangouts 5

Once you generate your service account private key, navigate to "Configuration" to configure your JetBackup Bot. On this page, you set up the name, avatar and description for your bot, as well as set permissions and available functionality. Under "Connection settings", select Bot URL and specify your server hostname.

google hangouts 6

Add Bot to a Google Chat Room

If you don't have a Google Chat Room setup yet, please click here for instructions.

Once you have a Chat Room setup, click on the + icon in the Bot section to open the bot catalog.

google hangouts 7

Enter the bot name we just configured in the search box. On the Bot Card, click on "Add" > "Add to room" then select which room(s) you would like to add the bot to.

google hangouts 8

Install and Activate the Google Hangouts Plugin

Once you have your Google Chat Bot and Chat Room configured, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

  1. On the Google Hangouts Notification Plugin, click "Install" then hit "Activate"
  2. On the Google Hangouts Notification Integration window, configure the following available options:
    • Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
    • Specify the Space Name (Google Chat Room) you would like to receive the JetBackup notifications to.
    • Enter the Service Account Key generated in your Google Developer Console then hit "Enable".

google hangouts Plugin

JetBackup will then attempt to verify that the Google Hangouts Plugin is properly configured by sending a notification to the space(room) you specified on the plugin. The room should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Google Chat.

google hangouts success



Telegram

Configure a JetBackup Telegram Bot

  1. Open your Telegram app and search for the user @BotFather. You can verify the correct user by looking for the blue checkmark next to the user's name.

telegram1

  1. Start a chat with the @BotFather and use the following command to begin the Create Bot Wizard: /newbot

    • Insert the name for your bot.

    • Insert the username for your bot.

      • NOTE: The username must be globally unique within Telegram.
  • Once complete you should receive an HTTP API Token for your bot. Keep this token somewhere safe as it will be used to verify your bot.

telegram2

NOTE: You may need to send a few messages in your new chat with the Telegram bot to update the bot data. Otherwise the activation method in the next step may fail. You can check the status of your Telegram bot by visiting https://api.telegram.org/bot{HTTP_API_TOKEN}/getUpdates in your browser. There should be at least one entry of "chat": {"id"}.

Install and Activate the Telegram Plugin

Once you have your Telegram Bot configured and have the Bot API Token, open JetBackup 5 and navigate to the Notification Settings (Settings > Notification).

  1. On the Telegram Notification Plugin, click "Install" then hit "Activate"

  2. On the Telegram Notification Integration window, configure the following available options:

    • Select the Notification Alert Levels and the frequency you would like to send your notifications. For more information about alert types, please visit Alerts.
    • Enter the Bot Token generated in your Telegram APP then hit "Enable".

telegram3

JetBackup will then attempt to verify that the Slack Plugin is properly configured by sending a notification to the chat you started with your bot and should receive the following prompt: "JetBackup notification integration configured successfully". JetBackup will now be able to send notifications through Telegram.

telegramSuccess