Airtable Sync integration: Jira Cloud
  • 24 Aug 2022
  • 4 Minutes to read
  • Dark
    Light

Airtable Sync integration: Jira Cloud

  • Dark
    Light

Airtable Sync integration allows you to bring information from external tools into a single, centralized table within Airtable. This article covers how to sync Jira issues found in specific filters to an Airtable base.

If you haven’t set up a sync before, we recommend first reading the Sync - Basic setup article to become familiarized with how sync works.

NOTE

Enterprise customers utilizing Jira Server / Data Center should consult this support article.

Add a new synced table

Start by clicking the + symbol next to your list of tables. Then, under “Sync data from”, select the “Jira” option.

1500007090121addsyncedtable.gif

Select a Jira account

Select an existing Jira account (if you’ve already connected to Jira), or link to a new Jira account. Once you link to the account, select the “Site” that you want to use to create the synced table - all of your existing sites will be available as options to select.

1500006904582selectaccount.png

You’ll then be able to choose which issue “Filter’ to use for creating Airtable records.

Choose a filter

It’s important to choose a filter with conditions that won’t change. Whenever a filter’s conditions are changed in Jira, records that no longer match are deleted, along with any additions made in Airtable.

For example, if you’ve synced a filter that only has open bugs, and a bug is closed, the Airtable record will be deleted along with any record comments and activity, and other field data that may have been added. If that same bug is reopened, a new Airtable record will be created.

As a result, we recommend choosing a filter that is unlikely to change.

NOTE

If you’ve lost Airtable records due to a changed filter, we may be able to help. Please reach out to our support team to request help.

Select fields to sync

After clicking next, you’ll be presented with two sync options; you can sync:

  1. All fields from the source view (Jira), including any fields added by Jira in the future.
  2. Specific fieldsfrom the source view (Jira).
    1500007090261selectfields.png

If you choose to sync specific fields you’ll be shown a menu where you can toggle each individual field that you want to sync from Jira.

1500007090421fields.jpeg

Field data that can be synced from Jira

Below is a list of all of the field data that is provided by Jira that can be synced to Airtable:

Issue KeyPriorityParent
SummaryLabelsEnvironment
DescriptionTime SpentAffects Versions
StatusAggregateEpic Name
Project Time SpentSprint
Issue TypeTime RemainingReporter
Created Aggregate Time RemainingFlagged
UpdatedOriginal EstimateStory Point Estimate
ComponentsDue DateStart Date
Story PointsLinked IssuesIssue Color
Fix VersionsAssignee


Create synced table

Before creating your synced table, there are Settings options that will allow you to choose how often you want to sync, and how to handle records that are deleted or hidden from the source (Jira). These options are:

  • The frequency of syncing. Right now, the options are manual syncing and automatic syncing which happens around every 5 minutes.
  • Whether or not deleted records (issues in the selected Jira filter) should be removed from the Airtable table. By default, deleted events will be removed.

1500006904762createsyncedtable.png

Once you’ve selected your desired settings, click the “Create table” button. The sync operation will retrieve all issues in the selected Jira filter and generate Airtable records.

1500006904802syncedtable.png

Security and OAuth scopes

Authentication

Airtable only interacts with a single Jira external account type, so the scopes listed here are also used for the Jira automations actions. This is why the scopes include write permissions. The OAuth consent screen will look like this:

4407012319127OAuthScreenJira.png

Airtable will only have access to the issues and filters that the user who connected the Jira sync has access to. If the user who connected a Jira sync leaves the company and their Jira account gets deactivated, the sync will stop working.

NOTE

There is no separate plugin or app that needs to be installed on the user’s Jira instance. The data that we retrieve from Jira’s API is transmitted securely via HTTPS and will not be used for any purpose other than the synced table.

Jira Cloud scopes

Scope nameScope purpose
offline_access
To get a refresh token
read:jira-userGet user information (e.g. might want to "mention" someone in a post)
read:jira-worke.g. reading issues
write:jira-worke.g. posting issues

The tokens are transmitted between Airtable and Jira’s servers securely via HTTPS. On Airtable’s side, the tokens are stored in databases that are encrypted at-rest.

For more information on Jira scopes, check out Jira's documentation here.

FAQs

What type of access will Airtable have to Jira?

Airtable will only have access to the issues and filters that the user who connected the Jira sync has access to.

What happens to the sync if the Jira account used becomes deactivated?

The sync will stop working if the connected Jira account is deactivated.

How is data transmitted from Jira?

The data that we retrieve from Jira’s API is transmitted securely via HTTPS and is not used for any purpose other than syncing data to the table.

Can custom fields in Jira be used in the Sync?

Custom fields that are based on Jira's built-in field types are supported, but other types of custom fields may not be supported.

Are there any limitations to be aware of?

The maximum number of issues synced is 10,000. This is a limit that we impose to ensure reasonable performance.

Additionally, Jira’s API is very limiting in terms of how much data can be transferred with each request, so sync performance in the range of 1 second per 100 issues is to be expected. We recommend that you choose filters that narrow your request wherever possible.


Was this article helpful?