Connect to Jira

You can connect to Jira using Retool's built-in Jira integration and make it available as a resource. Once complete, you can write queries to interact with the Jira API.

Requirements

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

To create your Jira resource, you need:

• REST API connection details.
• OAuth 2.0 authentication details.
• The cloudid for your Jira instance. You can retrieve this by making a GET request to https://api.atlassian.com/oauth/token/accessible-resources, or by navigating to https://your-site's-name.atlassian.net/_edge/tenant_info in a browser.

Jira uses OAuth authentication. If you self-host Retool, you must create an OAuth 2.0 client application that Retool uses to perform authentication. Refer to the Jira documentation to learn how to create a client application and obtain the required credentials.

If Jira is behind a firewall, you must also allow access from Retool's IP addresses. Add these IP addresses to your firewall's allowlist before you create the resource.

1. Create a new resource

Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Sign in to your Retool organization and create a new resource. Search for or select the Jira integration.

2. Configure the resource

Provide the necessary details to configure the resource so Retool can connect to Jira. Not all settings are required, but refer to the Jira documentation to learn what is needed.

General

These settings configure the name and location of the resource within Retool.

Name

The name to use for the resource (e.g., Jira).

Description

A brief description of the resource (e.g., Customer notes).

Folder

The folder in which to save the resource.

Credentials

These settings configure how Retool authenticates with Jira.

Server variables

Specify the domain to use to connect to Jira. Retool automatically fills in the domain field with api.atlassian.com/ex/jira/{cloudid}. Replace cloudid with your cloud ID.

API version

Specify the Jira API version to use.

Scopes

The scopes of the access to request. Learn more about the available scopes in the Jira documentation.

Self-hosted configuration

caution

This section is only necessary if you self-host Retool.

On self-hosted instances, you need to provide credentials for your Jira OAuth app. You can create an app in the Atlassian Developer Console. Copy the Retool-provided OAuth callback URL and set it as the callback URL for your app. In Retool, enter your app's Client ID and Client secret in the resource settings page.

3. Connect with OAuth

After you've finished setting up your Jira app and resource, click the Connect with OAuth → button on the resource settings page to authenticate.

4. Save the resource

Click Create resource to complete the setup. You can then click either Create an app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Jira resource is now ready to use. You write queries to make API requests by specifying the request method and endpoint, additional parameters to include, and the request body.

To verify you can successfully interact with Jira, write a test query to retrieve some data. The following example retrieves dashboards owned by or shared with the current user.

Request

GET api.atlassian.com/ex/jira/rest/api/2/dashboard

Response

Response

{
  "startAt": 0,
  "maxResults": 20,
  "total": 1,
  "dashboards": [
    {
      "id": "10000",
      "isFavourite": false,
      "name": "Default dashboard",
      "popularity": 0,
      "self": "https://api.atlassian.com/ex/jira/00000000-1111-2222-3333-4444-55555555}/api/2/dashboard/10000",
      "sharePermissions": [
        {
          "id": 10000,
          "type": "global"
        }
      ],
      "editPermissions": [],
      "view": "/jira/dashboards/10000",
      "isWritable": false,
      "systemDashboard": true
    }
  ]
}