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.

Slack Notification Plugin

slackSend: Send Slack Message

Simple step for sending a Slack message to specified channel.
Use the advanced settings to override the Slack Plugin global configuration to include: token and channel.
Please see the Slack Plugin global configuration for more details on the fields. Usage Example:
slackSend "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:
    slackSend "started ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
    • Type: String
  • attachments (optional)
    • Type: String
  • baseUrl (optional)
    Allows overriding the Slack Plugin Integration Base Url specified in the global configuration.
    • Type: String
  • botUser (optional)
    • Type: boolean
  • channel (optional)
    Allows overriding the Slack Plugin channel specified in the global configuration.
    slackSend 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.
    slackSend color: "#439FE0", message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: String
  • failOnError (optional)
    If set to true, then the step will abort the Workflow run if there is an error sending message.
    slackSend failOnError: true, message: "Build Started: ${env.JOB_NAME} ${env.BUILD_NUMBER}"
    • Type: boolean
  • teamDomain (optional)
    Allows overriding the Slack Plugin Integration Team Domain specified in the global configuration.
    • Type: String
  • token (optional)
    Allows overriding the Slack Plugin Integration Token specified in the global configuration.
    • Type: String
  • tokenCredentialId (optional)

    The ID for the integration token from the Credentials plugin to be used to send notifications to Slack. The "Kind" of the credential must be "Secret text." If both "Integration Token" and "Integration Token Credential ID" are set, the "Integration Token Credential ID" will take precedence for security reasons.

    This overrides the global setting.

    • 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.