Skip to content

Remove api/2 from Workflow2 Jira setup #3200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove api/2 from Workflow2 Jira setup #3200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/error-reporting/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,6 @@ No, Unreal crash reporting on Linux is not supported because the Unreal engine d

If you've set up a Backtrace integration with JIRA, but are not receiving any new JIRA issues from Backtrace, check on the following:

- Is your JIRA endpoint correct? Your Jira endpoint should end in /jira/rest/api/2/ or /rest/api/2/ , depending on your Jira configuration. Atlassian has recently released v3 in Beta, at this time it is not supported. Be sure to use a v2 endpoint.
- Is your project key correct?
- Does the JIRA user associated with the email you provided have permissions to create new issues in the project you specified?
- Are you using email/password or username/password combination instead of email/API Token or username/API Token? API Token can be obtained here.
Expand Down
28 changes: 0 additions & 28 deletions docs/error-reporting/workflow-integrations/issue-tracking/jira.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,33 +190,6 @@ To generate an RSA public and private key pair, run the following commands in yo
For more information about the settings, see [Jira Integration Settings](#jira-integration-settings).
1. Click **Save**.

## Jira Cloud (Legacy)
Copy link
Collaborator

@peter-shao peter-shao May 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to keep this? I thought we were going to re-add this functionality for on prem

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep it. I agree with Peter


1. Go to **Project settings** > **Workflow Integrations**.
1. Click **+**, then select **issue tracking** > **Jira**. <br></br>
You can configure the following settings:
- Jira API (required): The Jira Endpoint URL (see below for examples).
- Email (required): email associated with your Jira instance. For some users, the username of the Jira instance may be used.
- API Token (required): Jira API Token obtained here. Some Jira instances also support passwords in lieu of API Tokens, but that functionality is deprecated and will be removed.
- Project Key (required): The Jira Project Key.
- Issue Type: Jira Issue Type. Defaults to Bug if not present.
- Subject (required): Content to put in the Summary field of the ticket.
- Custom Field Mapping - Labels: See below
- Custom Field Mapping - Description: See below
- Custom Fields: See below

Next: After filling in the integration-specific settings, proceed to Common Settings to finish configuring the integration.

### Jira URL Examples

The Jira URL generally takes one of the following formats:

- https:<span>//yourhost.yourdomain.com/rest/api/2/</span>
- https:<span>//yourhost.yourdomain.com/jira/rest/api/2/</span>
- https:<span>//yourname.atlassian.net/rest/api/2/</span> (for Atlassian-hosted Jira sites)

Atlassian now also offers a v3 API that is currently in Beta, at this time v3 is not currently supported. Be sure to use a v2 endpoint. For more detailed information, see the reference for [Jira's REST APIs](https://developer.atlassian.com/server/jira/platform/rest-apis/).

## Jira Integration Settings

### Data Synchronization
Expand Down Expand Up @@ -309,7 +282,6 @@ To further automate your workflow, you can configure automated actions for your

If you've set up a Backtrace integration with Jira, but are not receiving any new Jira issues from Backtrace, verify the following:

- Is your Jira endpoint correct? Your Jira endpoint must end in /Jira/rest/api/2/ or /rest/api/2/, depending on your Jira configuration. Atlassian has recently released v3 in Beta, at this time it is not supported. Be sure to use a v2 endpoint.
- Is your project key correct?
- Does the Jira user associated with the email you provided have permissions to create new issues in the project you specified?
- Are you using email/password or username/password combination instead of email/API Token or username/API Token?
Expand Down