-
-
Notifications
You must be signed in to change notification settings - Fork 528
Notify_matrix
- Source: https://matrix.org/
- Icon Support: No
- Message Format: Text
- Message Limit: 1000 Characters per message
To use this plugin, you need to first set yourself up with your own matrix synapse s
Valid syntaxes are as follows:
- matrix://{user}:{password}@{matrixhost}/#{room_alias}
- matrixs://{user}:{password}@{matrixhost}/!{room_id}
You can mix and match as many rooms as you wish:
- matrixs://{user}:{password}@{matrixhost}/!{room_id}/#{room_alias}/
Note: If no user and/or password is specified, then the matrix registration process is invoked. The matrix servers actually allow this (if enabled to do so in their configuration) to connect as a temporary user with/without a password and/or user-name. Under normal circumstances you should probably always supply a {user} and {password}.
Note: Federated rooms identifiers are fully supported by Apprise. If no hostname is found in the {room_id} and/or {room_alias} entries specified, then apprise automatically uses the hostname returned to it (internally) upon login. For example, assume the following url: matrix://user:pass@localhost/#room/#room:example.com/!abc123/!def456:example.com:
- #room is internally interpreted as #room:localhost before it is accessed.
- #room:example.com is not altered and is directly notified as such
- !abc123 is internally interpreted as !abc123:localhost
- !def456:example.com is not altered and is directly notified as such
| Variable | Required | Description |
|---|---|---|
| hostname | Yes | The matrix server you wish to connect to. |
| user | No | The user to authenticate (and/or register) with the matrix server |
| password | No | The password to authenticate (and/or register) with the matrix server |
| port | No | The server port Matrix is listening on. By default matrixs:// uses a secure port port of 8448 while matrix:// uses port 8008. |
| room_alias | No | The room alias you wish to join (if not there already) and broadcast your notification. For ambiguity purposes you should prefix these locations with a pound/hashtag symbol # although it is not required. |
| room_id | No | The room id you wish to join (if not there already) and broadcast your notification. For ambiguity purposes, you MUST prefix these locations with a exclamation symbol ! (otherwise it is interpreted as a room_alias instead) |
| thumbnail | No | Displays an image before each notification is sent that identifies the notification type (warning, info, error, success). By default this option is set to False. |
Note: If neither a {room_alias} or a {room_id} is specified on the URL then upon connecting to the matrix server, a list of currently joined channels will be polled. Each and every channel the account is currently part of will automatically be notified.
Send a secure Matrix.org notification to our server
# Assuming our {hostname} is matrix.example.com
# Assuming our {user} is nuxref
# Assuming our {password} is abc123
# Assuming the {room_alias} we want to notify is #general and #apprise
apprise matrixs://nuxref:[email protected]/#general/#apprise