Jira Cloud Integration Setup

This article will walk through how to set up the Jira Cloud Integration for UserVoice. Before getting started, be sure to check out this article for an overview of the integration and its functionality. 

*Please note: The instructions in this article are for Jira Cloud only. If you need to set up the integration for Jira Server (self-hosted), see this article. 

These steps will require a Jira administrator and a UserVoice administrator to work together to complete the configuration process. The setup process must be completed in the order shown here. 

UserVoice Configuration

  1. Sign into the UserVoice admin console (yoursubdomain.uservoice.com/admin)
  2. Click the icon in the bottom left-hand corner to access your Settings
  3. Select "Integrations"
  4. Click "Jira" at the bottom of the page
  5. Click "Link Account"
  6. Enter the URL of Jira cloud instance that you would like to configure (https://acme.atlassian.net). If you don't know the URL of your Jira instance, contact your Jira Administrator.
  7. Select "Jira Cloud"
  8. Click "Submit"
  9. Under "Authorized Jira Instances" you will see the Jira instance URL you entered in Step 6 with a "Not Connected" status, an access token, and a link directly to the area in your Jira instance where a Jira Admin can complete the setup process. 
  10. A Jira Administrator will need the access token and the instructions listed below to complete the configuration process. Once a Jira Administrator completes the steps below, the "Not Connected" status will change to "Connected." This will indicate that the integration is successfully installed and ready to be used.

Jira Configuration

  1. Navigate to your Jira System Settings
  2. Select "Add-ons" -> "Find new add-ons"
  3. Search "UserVoice"
  4. Locate the UserVoice add-on and click "Install" -> Click "Accept and Install" to accept the permissions
  5. Click "Manage" on the install page to finish configuring the add-on. 
  6. Click "Configure". 
  7. On the subsequent page, enter the access token (provided to you by your UserVoice Admin who initiated this configuration in UserVoice) and click "Verify Token."
  8. Add the "UserVoice Links" custom field to the appropriate screens for your projects in Jira. During the Add-on configuration process, we automatically created a custom field in your Jira instance called "UserVoice Links." This custom field will allow you to see the linked UserVoice items when viewing an item in Jira. To enable this, click "Configure" under the "UserVoice for Jira" add on -> choose "Enable Screens for UserVoice Custom Field" -> check the box next to the appropriate screens -> click "Update".
  9. Change "UserVoice Links" renderer to "Wiki" style". This will allow your Jira items to display direct links to their corresponding UserVoice items. In your UserVoice for Jira configuration (Settings -> Add ons -> Manage add ons -> UserVoice for Jira -> Configure), click the link titled "Change UserVoice Links renderer to Wiki style". Scroll down to "UserVoice Links" and click the "Renderers" link on the right. Select 'Wiki Style Renderer' for the Active Renderer and click "Update" twice.
  10. You will know your token has been successfully redeemed when the Jira Integration page in your UserVoice admin settings says "Connected". You may need to refresh the page. At this point, your Jira instance is ready to be used with your UserVoice subdomain.

Common Questions

Q. Can I use this integration with Jira Server (on-premise)? 
A. The instructions in this article are only relevant for Jira Cloud. If you are using Jira Server please see this article

Q. Does updating the status of a Jira issue update the status of the linked Suggestion or Feature in UserVoice?
A. No. The status of linked Jira issues is visible in UserVoice, and the status of linked UserVoice features/suggestions is visible in Jira, but they do not automatically update the status of the other. This means that when a developer moves an issue in Jira to DONE, it does not automatically notify all the related supporters and contributors in UserVoice. This is because an issue being “DONE” in Jira doesn’t necessarily mean it’s ready for customers.

Q. Why are my UserVoice items not showing up in Jira?
A. Make sure you followed 'step 10' in the "Jira Configuration" section above to add the "UserVoice links" custom field to your Jira Projects. If you linked UserVoice items to Jira items before completing 'step 10', you will need to complete step 10, then unlink the items from within UserVoice and then re-link them. 

Q. If I split one Jira issue into two separate issues, will the linked UserVoice items be connected to both Jira Issues?
A. The UserVoice items will remain connected to the original Jira issue but they will not be connected to the new issue you created in Jira. 

Q. Is there a way to display Jira issue statuses to end-users?
A. No. Information about linked Jira issues, including status, is only visible to UserVoice admins in the admin console.

Q. Can Jira issues be created automatically from UserVoice Suggestions or Features?
A. Due to the potential for required fields in Jira, we do not have a way to do this automatically. However, when manually creating a Jira issue from within UserVoice, the issue’s summary and description will be pre-populated and a link back to UserVoice will be added by default. 

Feedback and Knowledge Base