Alerts

Matrix alerts

Table of contents
  1. Settings
    1. Matrix homeserver URL
    2. Matrix user ID
    3. Matrix access token
    4. Matrix internal room ID

Matrix is an open network for secure, decentralized communication. You can set up a Matrix alert to get status updates for selected monitors via Matrix.

Settings

Please see here for common configuration options that are common for all alert types.

Matrix homeserver URL

The Matrix homeserver URL is the base address of your Matrix server where your user account resides. It typically starts with https:// and includes your server domain, such as https://matrix.org for the public Matrix server.

Example:

https://matrix.example.com

Make sure the URL is correct and accessible, as this is required for WebGazer to send alerts to your room.

Matrix user ID

The Matrix user ID (MXID) identifies your user account on the homeserver. It starts with @ followed by your username and ends with the homeserver domain.

Example:

@username:matrix.example.com

Ensure that the user ID belongs to an account with access to the alert room you intend to use.

Matrix access token

The Matrix access token is required to authenticate WebGazer to send messages to your Matrix homeserver on your behalf. You can generate this token from your Matrix client or homeserver management tools.

To retrieve an access token:

  1. Log in to your Matrix client.

  2. Obtain the access token from your client's settings.

  3. Copy and paste the token here.

Important: Treat your access token like a password. Do not share it, and consider regenerating it if you suspect it has been compromised.

Matrix internal room ID

The Matrix internal room ID is a unique identifier for the room where you want to receive your WebGazer alerts. It differs from the room alias (e.g., #alerts:matrix.org) and always starts with !.

To find the internal room ID:

  1. Open the desired room in your Matrix client.

  2. Access the room settings to locate the room's internal ID.

Example:

!abcd1234:matrix.org

Ensure the specified user has permission to post messages in this room.

Once these settings are configured, WebGazer will deliver real-time alerts to your Matrix room, keeping you informed about your monitors' status. If you encounter any issues, please check the settings above, or reach out to us.