Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a SonarQube location.
sonarqube_api.png

Sonarqube

Create a SonarQube Destination​

  1. Click the + icon on the Nexset that will be sent to the SonarQube destination, and select the Send to Destination option from the menu.

  2. Select the SonarQube connector from the list of available destination connectors. Then, select the credential that will be used to connect to your SonarQube account, and click Next; or, create a new SonarQube credential for use in this flow.

  3. In Nexla, SonarQube destinations can be created using pre-built endpoint templates, which expedite destination setup for common SonarQube endpoints. Each template is designed specifically for the corresponding SonarQube endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    SonarQube destinations can also be configured manually, allowing you to send data to SonarQube endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common SonarQube endpoints. Each template is designed specifically for the corresponding SonarQube endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Add notification

    This endpoint template allows you to add notifications in your SonarQube account using records from a Nexset. Use this template when you need to create notifications for users or groups in your SonarQube account.

    • This endpoint sends data as JSON in the request body to add notifications in your SonarQube account. Each record from your Nexset will be sent as a separate API request to create a new notification. The request body should contain the notification data in the format required by the SonarQube API.

    This endpoint sends data as JSON in the request body to add notifications in your SonarQube account. Each record from your Nexset will be sent as a separate API request to create a new notification. The request body should contain the notification data in the format required by the SonarQube API, including notification type, recipient, and other notification properties.

    The notification structure must match the SonarQube API's expected format. For detailed information about notification creation, request body formats, and available notification properties, see the SonarQube Web API documentation.

    Set Project Tag

    This endpoint template allows you to set project tags in your SonarQube account using records from a Nexset. Use this template when you need to assign tags to projects in your SonarQube account.

    • This endpoint sends data as JSON in the request body to set project tags in your SonarQube account. Each record from your Nexset will be sent as a separate API request to set tags for a project. The request body should contain the tag data in the format required by the SonarQube API.

    This endpoint sends data as JSON in the request body to set project tags in your SonarQube account. Each record from your Nexset will be sent as a separate API request to set tags for a project. The request body should contain the tag data in the format required by the SonarQube API.

    The tag structure must match the SonarQube API's expected format. For detailed information about project tag management, request body formats, and available tag properties, see the SonarQube Web API documentation.

Configure Manually​

SonarQube destinations can be manually configured to send data to any valid SonarQube API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the SonarQube API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the SonarQube API from the Method pulldown menu. SonarQube API typically uses POST method for creating or updating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the SonarQube API from the Content Format pulldown menu. SonarQube API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the SonarQube API endpoint to which data will be sent in the URL field. This should be the complete URL to your SonarQube endpoint (e.g., https://sonarqube.com/api/notifications/add, https://sonarqube.com/api/project_tags/set). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The SonarQube API endpoint URL should point to the endpoint where you want to create or update resources. The endpoint URL should include the API path (/api/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the SonarQube API. The request body should contain the resource data formatted as JSON, with field names matching the SonarQube API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the SonarQube API's expected format for the specific endpoint you're using. SonarQube API uses specific structures for different endpoints (notifications, project tags, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the SonarQube Web API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.