Skip to main content

Matrix

The Matrix trigger lets you send container update notifications to Matrix rooms using the Client-Server API.

⚙️ Configuration Variables​

WUD_TRIGGER_MATRIX_{trigger_name}_ACCESSTOKEN
Requiredstring

Matrix user or bot account access token

WUD_TRIGGER_MATRIX_{trigger_name}_ROOMID
Requiredstring

Internal Matrix room ID where messages will be sent

Allowed values:Matrix room ID (e.g. !abcdef:matrix.org)
WUD_TRIGGER_MATRIX_{trigger_name}_URL
Requiredurl

Matrix homeserver base URL

Allowed values:Valid HTTP/HTTPS Homeserver URL (e.g. https://matrix.org)
WUD_TRIGGER_MATRIX_{trigger_name}_DISABLETITLE
Optionalbooleandefault: false

Whether to omit the notification title in message bodies

info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

🚀 Examples​

Basic Matrix Notification​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_MATRIX_MAIN_URL=https://matrix.example.com
      - WUD_TRIGGER_MATRIX_MAIN_ROOMID=!abcdef12345:example.com
      - WUD_TRIGGER_MATRIX_MAIN_ACCESSTOKEN=syt_botaccount_secrettoken