Skip to content
This documentation applies to Codacy Self-hosted v4.1.0

For the latest updates and improvements, see the latest Cloud documentation instead.

Jira integration#

The Jira integration incorporates Codacy on your existing Jira workflows.

When the integration is enabled, you can create issues on a Jira project directly from Codacy when browsing the existing issues on the repository:

Jira integration for issues

Enabling the Jira integration#

To enable the Jira integration:

  1. Open your project Settings, tab Integrations.

  2. Click the button Add integration and select Jira on the list.

  3. Configure the Jira integration fields as follows:

    Enabling the Jira integration

    • Host URL: Base URL of your Jira instance, including the protocol. For example, https://mycompany.atlassian.net/.
    • Repository ID: Key of the Jira project where Codacy will create issues. You can obtain the project key from the prefix of Jira issue numbers in that project. For example, DOCS for a project with the issue DOCS-42.
    • Email: Email address of the user account that Codacy will use to create new issues in Jira.
    • API token: Jira API token for the user account that Codacy will use to create new issues in Jira. The Jira integration only supports HTTP basic authentication.

    Important

    It's recommended that you use a dedicated Jira account for the integration. Jira issues created by Codacy will appear as being reported by this user account.

  4. Click Save and make sure that Codacy can successfully establish a connection with Jira.

  5. Click Advanced to configure the issue type and any built-in or custom Jira fields of new issues created by Codacy.

    Advanced settings of the Jira integration

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified March 18, 2021