The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Matrix Communication Plugin

matrixSendMessage: Send message to a Matrix room

  • accessTokenCredentialsId : String (optional)
    The id of the credentials holding the Matrix access token. The access token must be stored in the password-side of the credentials.
  • body : String (optional)
    The body of the message to be sent. e.g. Hello World.
  • format : String (optional)
    The format of the message to be sent. Defaults to org.matrix.custom.html.
  • formattedBody : String (optional)
    The formatted body of the message to be sent. e.g. Hello <b>world</b>.
  • hostname : String (optional)
    The Matrix server's hostname. e.g.
  • https : boolean (optional)
    True if https should be used. False otherwise. Defaults to true.
  • port : int (optional)
    The Matrix server's port. If no port is provided, port 80 will be used if https is false, port 443 otherwise.
  • roomId : String (optional)
    The Matrix room's id. e.g. !
  • type : String (optional)
    The type of the message to be sent. Defaults to m.text.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.