Notifications

Configure notification settings for backup events

Overview

Notification endpoints allow you to configure alerts for backup, restore, and check operations using Apprise service URLs.

List Notification Settings

Get all configured notification settings.

Endpoint: GET /api/notifications

Example Request:

curl http://localhost:5000/api/notifications \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

[
  {
    "id": 1,
    "name": "Slack Alerts",
    "service_url": "slack://token/channel",
    "enabled": true,
    "title_prefix": "[Production]",
    "include_job_name_in_title": true,
    "notify_on_backup_start": false,
    "notify_on_backup_success": false,
    "notify_on_backup_failure": true,
    "notify_on_restore_success": false,
    "notify_on_restore_failure": true,
    "notify_on_check_success": false,
    "notify_on_check_failure": true,
    "notify_on_schedule_failure": true,
    "monitor_all_repositories": true,
    "repositories": [],
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z",
    "last_used_at": "2024-01-15T10:30:00Z"
  }
]

service_url · string

Apprise service URL (e.g., slack://token/channel, discord://webhook_id/token, json://webhook_url)

title_prefix · string

Optional prefix for notification titles (e.g., [Production])

include_job_name_in_title · boolean

Include job/schedule name in notification title

monitor_all_repositories · boolean

If true, applies to all repositories. If false, only monitors specific repositories

Get Notification Setting

Get details for a specific notification configuration.

Endpoint: GET /api/notifications/{setting_id}

Example Request:

curl http://localhost:5000/api/notifications/1 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Create Notification Setting

Create a new notification configuration.

Endpoint: POST /api/notifications

name · string · required

User-friendly name for this notification setting

service_url · string · required

Apprise service URL. Examples:

• Slack: slack://token/channel
• Discord: discord://webhook_id/token
• Email: mailto://user:[e-mail]
• JSON Webhook: json://webhook_url or jsons://webhook_url (HTTPS)
• See Apprise documentation for more

enabled · boolean · default: true

Whether this notification is enabled

title_prefix · string

Optional prefix for notification titles

include_job_name_in_title · boolean · default: false

Include job/schedule name in notification title

notify_on_backup_start · boolean · default: false

Send notification when backup starts

notify_on_backup_success · boolean · default: false

Send notification when backup succeeds

notify_on_backup_failure · boolean · default: true

Send notification when backup fails

notify_on_restore_success · boolean · default: false

Send notification when restore succeeds

notify_on_restore_failure · boolean · default: true

Send notification when restore fails

notify_on_check_success · boolean · default: false

Send notification when repository check succeeds

notify_on_check_failure · boolean · default: true

Send notification when repository check fails

notify_on_schedule_failure · boolean · default: true

Send notification when scheduled job fails

monitor_all_repositories · boolean · default: true

Apply to all repositories. If false, specify repository_ids

repository_ids · array

List of repository IDs to monitor (only used if monitor_all_repositories is false)

Example Request:

curl -X POST http://localhost:5000/api/notifications \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Slack Alerts",
    "service_url": "slack://xoxb-token/C1234567890",
    "enabled": true,
    "title_prefix": "[Production]",
    "notify_on_backup_failure": true,
    "notify_on_restore_failure": true,
    "monitor_all_repositories": true
  }'

Response:

{
  "id": 1,
  "name": "Slack Alerts",
  "service_url": "slack://xoxb-token/C1234567890",
  "enabled": true,
  "title_prefix": "[Production]",
  "include_job_name_in_title": false,
  "notify_on_backup_start": false,
  "notify_on_backup_success": false,
  "notify_on_backup_failure": true,
  "notify_on_restore_success": false,
  "notify_on_restore_failure": true,
  "notify_on_check_success": false,
  "notify_on_check_failure": true,
  "notify_on_schedule_failure": true,
  "monitor_all_repositories": true,
  "repositories": [],
  "created_at": "2024-01-15T11:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "last_used_at": null
}

Update Notification Setting

Update an existing notification configuration.

Endpoint: PUT /api/notifications/{setting_id}

Example Request:

curl -X PUT http://localhost:5000/api/notifications/1 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'

Delete Notification Setting

Delete a notification configuration.

Endpoint: DELETE /api/notifications/{setting_id}

Example Request:

curl -X DELETE http://localhost:5000/api/notifications/1 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response: 204 No Content

Test Notification

Test a notification service URL before saving.

Endpoint: POST /api/notifications/test

service_url · string · required

Apprise service URL to test

Example Request:

curl -X POST http://localhost:5000/api/notifications/test \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "service_url": "slack://xoxb-token/C1234567890"
  }'

Response:

{
  "success": true,
  "message": "Test notification sent successfully"
}

Supported Services

Borg UI uses Apprise for notifications, supporting 80+ services:

• Chat: Slack, Discord, Telegram, Microsoft Teams, Mattermost
• Email: SMTP, Gmail, Outlook
• SMS: Twilio, AWS SNS, Nexmo
• Webhooks: JSON, XML, custom HTTP
• Push: Pushover, Pushbullet, Notify, Apprise

See the Apprise documentation for complete service URL formats.

Example Service URLs

Slack

slack://xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d/#general

Discord

discord://webhook_id/webhook_token

Email (Gmail)

mailto://user:[e-mail]?to=[e-mail]

JSON Webhook

json://webhook.example.com/endpoint

HTTPS JSON Webhook

jsons://webhook.example.com/endpoint