About SonarQube Server integration with Slack

With the SonarQube Server integration with Slack, users can receive real-time notifications on analysis results directly in Slack. The Slack messages contain context-rich notifications for immediate action, significantly cutting context-switching and improving code review feedback loop efficiency.

Currently, a notification is triggered when the quality gate status of a project’s main branch analysis transitions from Passed to Failed or from Failed to Passed.

Integration overview

The SonarQube Server app for Slack, installed in your Slack workspace, allows the integration of SonarQube Server with Slack:

• SonarQube Server is connected at the global level to your Slack workspace. An administrator installs and sets up the SonarQube app for Slack in their Slack workspace. This process links their Slack account with their SonarQube Server account.

• Once users have logged in to the SonarQube Server app for Slack, their SonarQube Server and Slack accounts are connected.

• Any Slack channel can be subscribed to notifications on one or several SonarQube Server projects:

• The channel’s member who performs the subscription must have Browse access to the project in SonarQube Server.

• All channel members receive the notifications.

Multiple-instance and multiple-workspace configurations

The same SonarQube Server instance can be connected to several Slack workspaces. To do so, the SonarQube Server administrator creates a single SonarQube Server app for Slack and installs it on several workspaces.

The same Slack workspace can be connected to several SonarQube Server instances. To do so, different slash commands must be configured for each SonarQube Server app for Slack to differentiate them.

The figure below illustrates the multiple-instance and workspace configurations:

• SonarQube Server’s instance 1 is connected to both Slack workspaces Alpha and Beta. The same SonarQube Server app is installed on both workspaces.

• Slack workspace Beta is connected to both SonarQube Server’s instance 1 and 2. Each instance uses its own SonarQube Server app.

Integration security

The notification process is as follows:

1. When an event to be notified occurs in SonarQube Server following the analysis of Project_abc, SonarQube Server sends the event notification to the SonarQube Server app for Slack to be sent to each Slack channel subscribed to this project.

2. The SonarQube Server app for Slack forwards the messages to all subscribed channels. All channel members receive the message.

Relates pages

Setting up the connection to Slack Subscribing to Slack notifications