Jira
Overview
This page contains the setup guide and reference information for the Jira source connector.
Features
Feature | Supported | Notes |
---|---|---|
Full Refresh Sync | Yes | |
Incremental Sync | Yes |
Supported streams
This connector outputs the following full refresh streams:
- Application roles (opens in a new tab)
- Avatars (opens in a new tab)
- Boards (opens in a new tab)
- Dashboards (opens in a new tab)
- Filters (opens in a new tab)
- Filter sharing (opens in a new tab)
- Groups (opens in a new tab)
- Issue fields (opens in a new tab)
- Issue field configurations (opens in a new tab)
- Issue custom field contexts (opens in a new tab)
- Issue link types (opens in a new tab)
- Issue navigator settings (opens in a new tab)
- Issue notification schemes (opens in a new tab)
- Issue priorities (opens in a new tab)
- Issue properties (opens in a new tab)
- Issue remote links (opens in a new tab)
- Issue resolutions (opens in a new tab)
- Issue security schemes (opens in a new tab)
- Issue type schemes (opens in a new tab)
- Issue type screen schemes (opens in a new tab)
- Issue votes (opens in a new tab)
- Issue watchers (opens in a new tab)
- Jira settings (opens in a new tab)
- Labels (opens in a new tab)
- Permissions (opens in a new tab)
- Permission schemes (opens in a new tab)
- Projects (opens in a new tab)
- Project avatars (opens in a new tab)
- Project categories (opens in a new tab)
- Project components (opens in a new tab)
- Project email (opens in a new tab)
- Project permission schemes (opens in a new tab)
- Project types (opens in a new tab)
- Project versions (opens in a new tab)
- Screens (opens in a new tab)
- Screen tabs (opens in a new tab)
- Screen tab fields (opens in a new tab)
- Screen schemes (opens in a new tab)
- Sprints (opens in a new tab)
- Time tracking (opens in a new tab)
- Users (opens in a new tab)
- UsersGroupsDetailed (opens in a new tab)
- Workflows (opens in a new tab)
- Workflow schemes (opens in a new tab)
- Workflow statuses (opens in a new tab)
- Workflow status categories (opens in a new tab)
This connector outputs the following incremental streams:
- Board issues (opens in a new tab)
- Issue comments (opens in a new tab)
- Issue worklogs (opens in a new tab)
- Issues (opens in a new tab)
- Sprint issues (opens in a new tab)
Experimental tables
The following tables depend on undocumented internal Jira API endpoints and are therefore subject to stop working if those endpoints undergo major changes.
While they will not cause a sync to fail, they may not be able to pull any data.
Use the "Enable Experimental Streams" option when setting up the source to allow or disallow these tables to be selected when configuring a secret.
Getting started
Requirements
- API Token
- Domain
Setting up the Jira source
- Create Jira API token
- To get access to the Jira API you need to create an API token, please follow the instructions in this documentation (opens in a new tab).
- Set up Jira as a Source
- Create a new Source of type Jira (Airbyte)
- Add a new Secret (or use an existing one).
- Enter the API Token that you have created. API Token is used for Authorization to your account by BasicAuth.
- Enter the Domain for your Jira account, e.g.
y42.atlassian.net
. - Enter the Email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
- Enter the Start Date (Optional) from which you'd like to replicate data for Jira in the format YYYY-MM-DDTHH:MM:SSZ. All data generated after this date will be replicated, or leave it empty if you want to replicate all data. Note that it will be used only in the following streams:BoardIssues, IssueComments, IssueProperties, IssueRemoteLinks, IssueVotes, IssueWatchers, IssueWorklogs, Issues, PullRequests, SprintIssues. For other streams it will replicate all data.
- Toggle Expand Issue Changelog allows you to get a list of recent updates to every issue in the Issues stream.
- Toggle Render Issue Fields allows returning field values rendered in HTML format in the Issues stream.
- Toggle Enable Experimental Streams enables experimental PullRequests stream.
Performance considerations
The Jira connector should not run into Jira API limitations under normal usage.