Webhooks notify external services when a project analysis is complete. An HTTP POST request including a JSON payload is sent to each URL. URLs may be specified at both the project and global levels. The project-level specification does not replace global-level webhooks. All hooks at both levels are called.
The HTTP(S) call:
- Is made regardless of the status of the background task.
- Includes a JSON document as payload, using the POST method.
- Has a content type of
application/json, with UTF-8 encoding.
You can configure up to 10 webhooks at the project level in Project Settings > Webhooks.
An additional set of 10 webhooks can be configured at the global level in Administration > Configuration > Webhooks.
If configured, all 20 will be executed.
The Webhook administration console shows the result and timestamp of the most recent delivery of each webhook with the payload available via the list icon. Results and payloads of earlier deliveries are available from the tools menu to the right of each webhook.
Response records are purged after 30 days.
The URL must respond within 10 seconds or the delivery is marked as failed.
An HTTP header
X-SonarQube-Project with the project key as the value is sent to allow quick identification of the project involved.
The payload is a JSON document that includes:
- When the analysis was performed: see
- The identification of the project analyzed: see
- Each Quality Gate criterion checked and its status: see
- The Quality Gate status of the project: see
- The status and the identifier of the background task : see
- User-specified properties: see
After you've configured your server to receive payloads, you want to be sure that the payloads you receive are initiated by SonarQube and not by attackers. You can do this by validating a hash signature that ensures that requests originate from SonarQube.
To set your secret in SonarQube:
- From the project or organization where you're securing your webhooks, navigate to the webhooks settings at Project Settings > Webhooks
- You can either click Create to create a new webhook or click an existing webhook's settings drop-down and click Update.
- Enter a random string in the Secret text box. This is used as the key to generate the HMAC hex digest value in the
- Click Update.
After setting your secret, it's used by SonarQube to create a hash signature with each payload that's passed using the
X-Sonar-Webhook-HMAC-SHA256 HTTP header. The header value needs to match the signature you are expecting to receive. SonarQube uses an HMAC lower-case SHA256 digest to compute the signature of the request body. Here's some sample Java code for your server:
If the signatures don't match, then the payload should be ignored.
A basic authentication mechanism is supported by providing login and password in the URL of the Webhook like this:
If you provide additional properties to your SonarScanner using the pattern
sonar.analysis.*, these properties will be automatically added to the section properties of the payload.
For example these additional parameters:
Would add this to the payload: