> User Documentation Home

User Handbook
Tutorials
Resources

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.

Mattermost Notification Plugin

View this plugin on the Plugins site

mattermostSend: Send Mattermost message

Simple step for sending a Mattermost message to specified channel.
Use the advanced settings to override the Mattermost Plugin global configuration to include: endpoint, channel and icon.
Please see the Mattermost Plugin global configuration for more details on the fields. Usage Example:
mattermostSend "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
  • message
    This is the main text in a message attachment, and can contain standard message markup. The content will automatically collapse if it contains 700+ characters or 5+ linebreaks, and will display a "Show more..." link to expand the content. Message may include global variables, for example environment and currentBuild variables:
    mattermostSend "started ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
    • Type: String
  • channel (optional)
    Allows overriding the Mattermost Plugin channel specified in the global configuration.
    mattermostSend channel: "#channel-name", message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: String
  • color (optional)
    An optional value that can either be one of good, warning, danger, or any hex color code (eg. #439FE0). This value is used to color the border along the left side of the message attachment.
    mattermostSend color: "#439FE0", message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: String
  • endpoint (optional)
    Allows overriding the Mattermost Plugin endpoint (url?token) specified in the global configuration.
    • Type: String
  • failOnError (optional)
    If set to true, then the step will abort the Workflow run if there is an error sending message.
    mattermostSend failOnError: true, message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: boolean
  • icon (optional)
    Allows overriding the Mattermost Plugin Integration icon specified in the global configuration.
    • Type: String
  • text (optional)
    This text is the main message after the message attachment, and can contain standard message markup. The content may contain user "mentions" and highlights.
    mattermostSend prext: "@foo @bar" color: "#439FE0", message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: String

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.