Integrate Jira

Integrate with Jira to track issues and get automated updates about tasks on any device, intranet, or messenger.

Use the following process to enable the integration with Jira. After you complete this process, your existing level of audit logging persists, including any actions carried out by the use of Citrix Microapps.

For a comprehensive list of out-of-the-box Jira microapps, see Use Jira microapps.

Review prerequisites

All user accounts that you want to use through this integration must have visibility for their email in account settings set to Anyone. This means service accounts as well as the accounts that users log in to Citrix Workspace through OAuth. Navigate to https://id.atlassian.com/manage-profile/profile-and-visibility, log in if required, in Contact section and next to the email account select Anyone under the Who can see this? menu.

After you prepare this integration in Jira, you will need these artifacts to add the integration in Citrix Workspace Microapps:

  • URL
  • Username
  • Password - You must enter the API token as your Password when you add the integration to Citrix Workspace Microapps
  • Authentication Method (either credentials or OAuth2)

For OAuth 2.0 you also need:

  • Client ID
  • Client Secret

Note: It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum security compliance with your configured microapp.

The following prerequisites must be met before you begin the integration process:

Enabling OAuth 2.0 (3LO)

Before you implement OAuth 2.0 (3LO), you need to enable it for your app in Jira app management.

  1. Navigate to App management.
  2. Create a new app by selecting Create new app, enter a name, agree to the terms, and select Create.
  3. Copy the Client ID and Secret for later use
  4. In the APIS AND FEATURES section in the side navigation, click +Add
  5. In the Features section of the APIs and features page find OAuth 2.0 (3LO), and select Add and then Configure.
  6. Enter the Callback URL. Set this URL to any URL that is accessible by the app. When you implement OAuth 2.0 (3LO) in your app (see next section), the redirect_uri must match this URL.
  7. Click Save changes.

Your screen looks something like this: Jira OAuth2

Create API Token

A script or other process can use an API token to perform basic authentication with Jira Cloud applications or Confluence Cloud. You must use an API token if the Atlassian account you authenticate with has had two-step verification enabled. Go straight to the API Tokens page and step 3 if you are logged in using API Tokens.

  1. Click your user profile in the bottom left.
  2. Select Profile > Manage your account > Security > Create and manage API tokens.
  3. Select Create API token and enter a name for the token in the Label field.
  4. Copy to clipboard and save for later use.

You must enter the API token as your Password when you add the integration to Citrix Workspace Microapps.

Add the Jira platform REST API

If you haven’t already added the Jira platform REST API, do this now.

  1. In the APIS AND FEATURES section in the side navigation, click +Add.
  2. In the APIs section of the APIs and features page find OAuth 2.0 (3LO), and select Add and then Configure.
  3. Add the desired scopes for your app.

Set duration to retrieve issues

Set the duration that you want to retrieve issues in Jira. When you add the integration to Citrix Workspace Microapps, the amount of data the integration retrieves from Jira can be limited by applying a load filter.

  1. Log in to Jira with your dedicated user account and password.

    Note:

    If you are using an existing account, the username is not the email of the account. To find the Username of an account, log in to your Jira instance, select the profile thumbnail, select Profile.

  2. Enter the number of days of issues to retrieve.

    Default: 90 days.

Add callback URL

Add a custom URL to your instance configuration to grant access to private data and enable OAuth authenticated user actions. Log in to Jira as an admin and add the following authorized redirect URL for this integration:

https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback

Add the integration to Citrix Workspace Microapps

Add the Jira integration to Citrix Workspace Microapps to connect to your application. This delivers out-of-the-box microapps with pre-configured notifications and actions which are ready to use within your Workspace.

Follow these steps:

  1. From the overview page, select Get Started.

    The Manage Integrations page opens.

  2. Select Add New Integration, and Add a new integration from Citrix-provided templates.
  3. Choose the Jira tile to add.
  4. Enter a name for the integration.

    Jira connector parameters, URL, Username, Password, User Authentication

  5. Enter the Connector parameters that you collected as prerequisites.
    • Enter your URL.
    • Enter your Service Authentication Username and Password.

      Note:

      Enter the API token you collected in a previous step as your Password when you add the integration to Citrix Workspace Microapps.

  6. Select an Authentication Method. Use the OAuth 2.0 security protocol to generate request/authorization tokens for delegated access.
    • Credentials - Credentials The client’s credentials are used.
    • Oauth 2.0 - Enter the OAuth Client ID and OAuth Client Secret that you collected in the prerequisites procedure.
  7. Select the number of Changed Tickets Weeks To Load.
  8. Select Add.

The Microapp Integrations page opens with your added integration and its microapps. From here you can add another integration, continue setting up your out-of-the-box microapps, or create a new microapp for this integration.

You are now ready to set and run your first data synchronization. As a large quantity of data can be pulled from your integrated application to the Microapps platform, we recommend you use the Table page to filter entities for your first data synchronization to speed up synchronization.

For more information, see Verify needed entities and Set data synchronization in the Configure the integration article.

For more details of API endpoints and table entities, see Jira connector specifications.

Use Jira microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Jira Microapps

Our Jira integration comes with the following preconfigured out-of-the-box microapps:

Create Ticket: Create a new Jira ticket with details.

Notification or Page Use-case workflows
Create Ticket page Provides a form for creating a new Jira ticket, including selecting an issue type, project, and optionally an assignee, and also a field for adding a description.

Tickets: View tickets, add comments, create sub-tasks, and change status and assignee.

Notification or Page Use-case workflows
Comment Edited (Assigned Ticket) notification When a comment is edited on an existing ticket that assigned to a user, they receive a notification of the edited comment in Workspace.
Comment Edited (Reported) notification When a comment is edited on an existing ticket that a user reported, they receive a notification of the edited comment in Workspace.
New Comment (Assigned Ticket) notification When a new comment is added to an existing ticket that assigned to a user, they receive a notification.
New Comment (Reported Ticket) notification When a new comment is added to an existing ticket that a user reported, they receive a notification.
Ticket Assigned to You (Change) notification When an existing ticket is assigned to a user, they receive a notification.
Ticket Assigned to You (New) notification When a new ticket is assigned to a user, they receive a notification.
Ticket Assignee Change (Reported) notification When a ticket is reassigned, the reporter of the ticket receives a notification.
Ticket Status Change (Assigned Ticket) notification When the status of a ticket is changed, the assignee of the ticket receives a notification.
Ticket Status Change (Reported) notification When the status of a ticket is changed, the reporter of the ticket receives a notification.
Add Comment page Provides a form for adding a comment to a Jira ticket.
Change Assignee page Provides a form for changing the assignee of a Jira ticket.
Change Status page Provides a form for changing the status of a Jira ticket.
Comment Detail page Provides a read only view of a comment with details.
Create Sub-Task page Provides a form for creating a sub-task for a Jira ticket.
Ticket Detail page Provides a read only view of a Jira ticket with details.
Tickets page Allows users to search for Jira tickets that are assigned to them, reported by them, or that they have commented on.