backy-docs/content/config/notifications.md

title	weight	description
Notifications	3	This page tells you how to get set up Backy notifications.

Notifications can be sent on command list completion and failure.

The supported platforms for notifications are email (SMTP) and Matrix.

Notifications are defined by type. The top-level object will be the id, and the type is required.

{{% notice info %}} Type in a cmd-configs object must match one of these. {{% /notice %}}

notifications:
  prod-email:
    type: mail
    host: yourhost.tld
    port: 587
    senderaddress: email@domain.tld
    to:
      - admin@domain.tld
    username: smtp-username@domain.tld
    password: your-password-here

  matrix:
    type: matrix
    home-server: your-home-server.tld
    room-id: room-id
    access-token: your-access-token
    user-id: your-user-id

Types recognized are type: mail and type: matrix

The type's object and its keys are listed below.

type: mail

key	description	type
host	Specifies the SMTP host to connect to	string
port	Specifies the SMTP port	uint16
senderaddress	Address from which to send mail	string
to	Recipients to send emails to	[]string
username	SMTP username	string
password	SMTP password	string

type: matrix

key	description	type
home-server	Specifies the Matrix server connect to	string
room-id	Specifies the room ID of the room to send messages to	string
access-token	Matrix access token	string
user-id	Matrix user ID	string

To get your access token (assumes you are using Element) :

1. Log in to the account you want to get the access token for. Click on the name in the top left corner, then "Settings".
2. Click the "Help & About" tab (left side of the dialog).
3. Scroll to the bottom and click on <click to reveal> part of Access Token.
4. Copy your access token to a safe place.

To get the room ID:

1. On Element or a similar client, navigate to the room.
2. Navigate to the settings from the top menu.
3. Click on Advanced, the room ID is there.

{{% notice info %}} Make sure to quote the room ID, as YAML spec defines tags using !. {{% /notice %}}