Drone plugins > Matrix
matrix.svg

Matrix

by drone-plugins


This plugin can be used to send build success or failure messages to a Matrix room.

Example

kind: pipeline
name: default

steps:
- name: notify
  image: plugins/matrix
  settings:
    homeserver: https://matrix.org
    roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
    username: octocat
    password: p455w0rd

Properties

  • homeserver

    stringoptional

    The Matrix homeserver URL.

    Default: https://matrix.org

  • roomid

    stringrequired

    Room ID to send messages (not alias, but ID, and you can skip the !).

    Default: none

  • username

    stringrequired

    Username on homeserver.

    Default: none

  • password

    stringrequired

    Password on homeserver (use with username).

    Secret recommended

    Default: none

  • userid

    stringoptional

    Matrix user ID (@user:homeserver.tld).

    Default: none

  • accesstoken

    stringoptional

    Matrix access token (use with userid).

    Secret recommended

    Default: none

  • template

    stringoptional

    Template to use for message.

    Default: none