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

Create a Slack App

1. Visit https://api.slack.com/apps 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.

2. Under the "Features" section, click on "OAuth & Permissions" .

3. Scroll down to "Scopes: Bot Token Scopes", click on "Add an OAuth Scope" and apply the following permissions:

• channles:read
• channels:join
• chat:write
• groups:read

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

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.

Private Slack Channels

If the notifications will be going to a private channel, there is one additional step to take in the Slack application.

• Go into the channel's details.
• Click on the Integrations tab.
• Under the Apps box, click "Add an App".

• Locate and add the app you created on the Slack API site.

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".

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.

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.

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

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.

2. 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.

• 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.

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".

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.

Microsoft Teams

Register a Teams Apps with Microsoft Entra ID on Microsoft Graph

1. Visit https://portal.azure.com/#home and sign in with your Microsoft Account to create and register a new app for Microsoft Teams.
2. Navigate to "Microsoft Entra ID" by either clicking on the “View” button under the “Manage Microsoft Entra ID” at the home screen, or clicking “Microsoft Entra ID” at the expandable navigation bar on the left-hand side.

3. Once you’re in the “Microsoft Entra ID” page, navigate to “App registrations” and click on “+ New Registration”

4. Once on the App Registration page, fill in the following items:

   • Name: the name that will be displayed when JetBackup sends notifications to Teams.

   • Supported account types: Choose which account types can access your app.

     a. Accounts in this organizational directory only All user and guest accounts in your directory can use your application or API.
     b. Accounts in any organizational directory (Any Azure AD directory - Multitenant) All users with a work or school account from Microsoft can use your application or API. This includes schools and businesses that use Office 365.
     c. Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox All users with a work or school, or personal Microsoft account) can use your application or API. It includes schools and businesses that use Office 365 as well as personal accounts that are used to sign in to services like Xbox and Skype.

     Please use the account type that is most appropriate for your needs. For this example, we used option 3 to give the most open access for demo purposes.

   • Redirect URI (required): the JetBackup notification plugin requires the Teams notification application to reach out to our Microsoft Teams authenticator. Select “Web” under application and set the following URI: https://auth.jetbackup.com/msteams/

   • Click on Register

5. Once registered, you will be redirected back to your Application’s Overview page. Here you will be able to get an overview of your apps’ display name, Application ID, Directory ID, and other information that will be needed to connect your app to the JetBackup Notification plugin.

6. The next step is to set the required API permission to allow the JetBackup Notification plugin to communicate with your Teams App. From your application’s Overview Page, navigate to “API permissions” > “+ Add a permission”.

7. The Request API permissions window will pop up. Select “Microsoft Graph” > “Delegated permissions”, enable the following permissions then click “Add permissions”:

   • Offline_access (Listed under "OpenId permissions")
   • Channel.Create (Listed under "Channel")
   • Channel.ReadBasic.All (Listed under "Channel")
   • ChannelMessage.Send (Listed under "ChannelMessage")

8. The next step is to generate a Client Secret that your application will use as identification when requesting a token for authentication. Under the Application page, navigate to “Certificates & secrets” > “Client secrets” > “+ New client secret”. The “Add a client secret” window will pop up and you will be asked to specify a Description and how long the secret will take to expire then click Add.

9. Once added, take note of the Value and Secret ID. Please also note that you would need to generate a new client secret once it expires and update the Value on your JetBackup Teams Notification Plugin.

10. The next step is to provide admin consent to your application. First, navigate back to the “Azure Activity Directory” page then select “Enterprise applications” at the navigation bar. On the Enterprise applications page, you should see the app you just created. Click on your app then navigate to the “Permissions” page under Security. Click on the Grant admin consent button for your user to your application, select the appropriate account then click accept.

Once done, the application is ready to be set up in JetBackup 5.

Install and Activate the Microsoft Teams Plugin

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

2. On the Teams Notification Plugin, click "Install" then hit "Activate".

3. On the Teams 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

4. You will then be asked to specify the following items:

   • Teams ID (Group ID): Can be found in the following interface: https://admin.teams.microsoft.com/teams/manage copy and use your Group ID.

-   Channel Name: The channel under your Team that you would like to receive notifications to
-   Client ID - Can be found on your Microsoft AD application Overview Page (Application (client ID))
-   Client Secret (Value generated on [Step 8 - Client Secret](#microsoft-teams))
-   Tenant ID (Can be found on your Microsoft AD Home Page)
-   Authorization Code (Once everything above is specified, click on "Get Authorization Code" and the JetBackup Teams Authorization Code Generator will pop up. Copy the code and paste it on this field.)
-   Hit \"**Save**\"

5. JetBackup will then attempt to verify that the TeamsPlugin 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 your Teams Channel.