Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.39 KB

README.md

File metadata and controls

58 lines (42 loc) · 2.39 KB
Raw

Matrix

Send notifications to Matrix network rooms.

The requirements for this notification method are:

  1. The url of the homeserver (https://homeserver:port).
  2. Credentials for connecting to the homeserver, in the form of a valid access token for your account (or for a dedicated notification account). These tokens usually don't expire.
  3. The room ids that you want to sent the notification to.

To obtain the access token, you can use the following curl command:

curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpass"}' "https://homeserver:8448/_matrix/client/r0/login"

The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot). Their format is !uniqueid:homeserver.

Multiple room ids can be defined by separating with a space character.

Detailed information about the Matrix client API is available at the official site.

Your health_alarm_notify.conf should look like this:

###############################################################################
# Matrix notifications
#

# enable/disable Matrix notifications
SEND_MATRIX="YES"

# The url of the Matrix homeserver
# e.g https://matrix.org:8448
MATRIX_HOMESERVER="https://matrix.org:8448"

# A access token from a valid Matrix account. Tokens usually don't expire,
# can be controlled from a Matrix client.
# See https://matrix.org/docs/guides/client-server.html
MATRIX_ACCESSTOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

# Specify the default rooms to receive the notification if no rooms are provided
# in a role's recipients.
# The format is !roomid:homeservername
DEFAULT_RECIPIENT_MATRIX="!XXXXXXXXXXXX:matrix.org"

analytics