matrix – Send notifications to matrix¶
New in version 2.8.
Requirements¶
The below requirements are needed on the host that executes this module.
- matrix-client (Python library)
Parameters¶
Examples¶
- name: Send matrix notification with token
  matrix:
    msg_plain: "**hello world**"
    msg_html: "<b>hello world</b>"
    room_id: "!12345678:server.tld"
    hs_url: "https://matrix.org"
    token: "{{ matrix_auth_token }}"
- name: Send matrix notification with user_id and password
  matrix:
    msg_plain: "**hello world**"
    msg_html: "<b>hello world</b>"
    room_id: "!12345678:server.tld"
    hs_url: "https://matrix.org"
    user_id: "ansible_notification_bot"
    password: "{{ matrix_auth_password }}"
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Jan Christian Grünhage (@jcgruenhage)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
