Jira Integration

Query Jira via Retool.

Connecting to Jira

To build Retool apps with your Jira data, you'll first need to create a resource for querying the Jira API. Resources sit on top of our integrations and store the authentication and metadata fields required for you to connect to a data source.

Get started by navigating to the Resources page, clicking Create new and then selecting Jira as your resource type.

Retool hosted setup

Retool uses OAuth to connect to Jira, allowing you to authenticate with just a few clicks.

First, enter a name for your resource that you’ll use when querying it in the editor (e.g. “DevOps JIRA”). Next, you’ll need to enter your Jira domain. Construct your domain URL using the following structure:

api.atlassian.com/ex/jira/{cloudid}

  • {cloudid} is the cloudid for your site. For example, 11223344-a1b2-3b33-c444-def123456789. You can retrieve this by making a GET request to https://api.atlassian.com/oauth/token/accessible-resources, passing the access token as a bearer token in the header of the request.

Click Test OAuth integration with your own account.

Then, follow the Jira authorization steps to authorize the access for the same domain you entered in the server variables and press Accept. After completing the authorization flow, you should see a message indicating a successful connection. Your resource is ready for use!

Self hosted setup

If you host Retool yourself, you'll need to provide credentials for an Atlassian OAuth2 app. You can create an app and access credentials via the Atlassian Developer Console.

First, Enter a name for your resource that you’ll use when querying it in the editor (e.g. “DevOps JIRA”).

Then, enter your client ID and client secret, and confirm your Atlassian app is using the Retool provided callback URL.

You'll also need to enter the name of your Jira domain. Construct your domain URL using the following structure:

api.atlassian.com/ex/jira/{cloudid}

  • {cloudid} is the cloudid for your site. For example, 11223344-a1b2-3b33-c444-def123456789. You can retrieve this by making a GET request to https://api.atlassian.com/oauth/token/accessible-resources, passing the access token as a bearer token in the header of the request.

Click Create Resource.

You can now select your newly-created Jira resource from the Resource dropdown in in the in-app Query Editor, as well as the Query Library.

Querying the Jira API

After setting up a Jira integration with Retool, a new option for a Jira query will appear in the select a resource dropdown of the Retool query editor. After selecting that option, you will be presented with a UI that allows you to use any of the end points in the Jira API spec to send and retrieve data from Jira. You can learn about the popular examples and endpoints like creating a new issue, modifying a project, assign tickets to users and more here.


Did this page help you?