All pages
Powered by GitBook
1 of 9

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Notifications

Email notifications
Slack notifications
Webhook notifications
Cover
Cover
Cover

Email notifications

Slack notifications

Webhook notifications

Cover
Configuration
Cover
SMTP server setup
Cover
Configuration
Cover
Creating a webhook URL in Slack
Cover
Configuration

Configuration

This article explains how to configure Slack notifications in Xopero ONE.

Notifications setup

1

Login to XMS, go to âš™ Settings > Slack notifications and switch the toggle to enable them.

2

Click the Enable notifications tile to open the settings.

3

Expand the Webhook address tab and enter the webhook URL for the Slack channel that should receive notifications.

4

Click the Test button to send a test message to your channel. If everything works correctly, click Save to proceed.

5

Next, expand the Slack notifications tab to configure additional settings, such as language and .

6

To finish the email notifications setup, review your settings and click Save.


Below is a list of available notification types:

  1. Backup plan summary — a notification is sent immediately after the backup task is finished or if it cannot be started. You can specify which task notifications you want to receive:

    1. Successfully finished tasks — notifies you about all successfully completed tasks.

    2. Tasks finished with warnings — notifies you about all tasks completed with warnings.

Creating a webhook URL in Slack

To generate a webhook URL, open your Slack and proceed with the following steps:

  1. Create your Slack app— pick a name, choose a workspace to associate your app with, and click Create App.

  2. In the opened window, select the Incoming Webhooks feature and click the Activate Incoming Webhooks toggle to switch it ON.

  3. Once incoming webhooks are enabled, the settings page will refresh and additional options will appear. Click Add New Webhook to Workspace, select a channel where you want to receive notifications and confirm by clicking Allow.

  4. Slack will display the webhook URL— copy and paste it into the webhook field (⚙ Settings > Slack notifications > Webhook address) in Xopero ONE.

  5. Click the Test button to send a test message to your channel. If everything works correctly, click Save to proceed.

SMTP server setup

This article explains how to configure an SMTP server in Xopero ONE.

SMTP server configuration settings are available only for on-premise Xopero services.

Server configuration

1

Navigate to âš™ Settings > E-mail notifications and click this tab to expand its settings.

2

Expand the E-mail server tab.

3

Specify the SMTP server configuration:

  1. Enter the SMTP server IP address and SMTP port.

  2. Enter the sender's e-mail address.

4

If the server requires authentication:

  1. Check the Server requires authentication checkbox to display additional settings.

  2. Enter the login and either select the password from the Password Manager or add a new one.

5

Optionally, send a test message to verify that the settings are correct.

6

Review your settings and click Save to finish the setup.

Configuration

This article explains how to configure email notifications in Xopero ONE.

1

Login to XMS, go to âš™ Settings > Email notifications and switch the toggle to enable them.

2

Configuration

In addition to e-mail and Slack, you can use any webhook-enabled portal to receive notifications from the Xopero ONE system. For webhooks, configuration is limited to providing the webhook URL— by default, the system sends reports for all completed backups. The POST request sent by Xopero ONE to the specified webhook URL contains details such as the plan ID, plan name, execution times, and other relevant information.

1

Login to XMS, go to âš™ Settings and click Webhooks to open the settings.

Learn more about Slack webhooks in the official Slack knowledge base article.

Failed tasks — notifies you about all failed tasks.

  • Canceled tasks — notifies you about all canceled tasks.

  • Tasks not started — notifies you about tasks that could not be started.

  • Restore verification summary — sent after the data restoration process is completed; includes a detailed summary.

  • Daily report — an aggregate summary of all backup tasks performed during the day, sent at a manually defined time.

  • SLA Reports — monthly summary of backup correctness for the protected environment.

  • Storage capacity notifications — alerts you when storage usage exceeds the defined limit.

  • Learn how to create a webhook address in this article.

    Available notification types

    notification types
    Click the Enable notifications tile to open the settings.
    3

    Expand the Recipients tab and select or enter the email addresses that should receive notifications.

    4

    Next, expand the Email notifications tab to configure additional settings, such as language and notification types.

    5

    To finish the email notifications setup, review your settings and click Save.


    Below is a list of available notification types:

    1. Backup plan summary — a notification is sent immediately after the backup task is finished or if it cannot be started. You can specify which task notifications you want to receive:

      1. Successfully finished tasks — notifies you about all successfully completed tasks.

      2. Tasks finished with warnings — notifies you about all tasks completed with warnings.

      3. Failed tasks — notifies you about all failed tasks.

      4. Canceled tasks — notifies you about all canceled tasks.

      5. Tasks not started — notifies you about tasks that could not be started.

    2. Restore verification summary — sent after the data restoration process is completed; includes a detailed summary.

    3. Daily report — an aggregate summary of all backup tasks performed during the day, sent at a manually defined time.

    4. SLA Reports — monthly summary of backup correctness for the protected environment.

    5. Storage capacity notifications — alerts you when storage usage exceeds the defined limit.


    Notifications can also be configured for individual backup plans—you don't have to enable them for all plans. If only certain plans should have notifications, enable them within the backup plan settings (Backup plan settings > Advanced settings > Edit > Email notifications).

    Similarly, if you want to maintain general notification settings but exclude specific plans, you can do so in the plan’s edit mode. Disabling notifications for a plan means that no notifications will be sent for that plan.


    Email notifications are also available for expiring personal access tokens (PAT) to prevent backup tasks from failing due to an expired PAT used for integrating an organization with a DevOps platform (or at least to minimize the time needed to resolve this issue).

    This configuration is organization-specific and can be adjusted in XMS under DevOps > your organization (i.e., GitHub) > Edit > Email notifications.

    1. Enter the email address(es) that should receive notifications.

    2. Select the preferred notification language.

    3. Check Expired Personal Access Token checkbox.


    In Xopero ONE, keeping data storage within capacity limits is crucial for maintaining efficient and reliable backup operations. When a repository approaches its storage limit, the service administrator should receive timely notifications which include the storage name and type, current usage, and remaining available space.

    Global settings:

    1. Go to âš™ Settings > Email notifications and click the Email notifications tab to expand it.

    2. Scroll down to the bottom of the settings panel and switch the Storage capacity notification toggle to enable it.

    3. Set the threshold at which the notification should be sent, then click Save.

    Storage-specific settings:

    1. Navigate to the Storages tab.

    2. Select the specific storage and click the edit icon next to it.

    3. In the storage settings, enable and configure the Storage capacity notification option and click Save. These settings will override the global configuration for this specific storage.

    Notifications setup

    Email notifications are enabled by default, with the root account email address set as the default recipient.

    Available notification types

    Notifications per backup plan

    Settings configured within a backup plan override the general settings.

    Exipiring personal access tokens notifications

    For proper setup, complete the following steps:

    This section is visible only for organizations that use personal access tokens.

    For Xopero ONE on-premise application, notifications are sent only if an SMTP server is properly configured.

    Storage space notifications

    Storage space notifications are sent every 24 hours until the issue with the exceeded storage space is resolved by reducing storage usage.

    Notifications can be configured either globally (for the entire system) or individually for each storage:

    2

    Click Add new button at the bottom of the panel, enter the webhook URL and click Save to finish the setup.

    By default, Xopero ONE sends a summary after each backup plan is finished. Notification configuration is not available.


    General information

    The POST requests sent by Xopero ONE have a fixed format that cannot be changed. If the system you want to use for receiving notifications requires a different format, it cannot be configured to accept Xopero ONE notifications.

    Notifications setup

    Examples

    Example of a full POST request sent by the Xopero ONE system to a test webhook using

    Pipedream