
Configuring Jira as a Source
In the Sources tab, click on “Add source” and select Jira from the list of connectors. Click Next and follow the setup steps below.1. Add account access
Use your Jira Cloud credentials and workspace information. If needed, check Jira’s REST API documentation. The following configurations are available:- API token: The token used to authenticate against Jira. For instructions on generating it, check Atlassian’s guide.
- User email: The email address associated with the API token.
- Workspace domain: Your Jira domain, without
https://(for example,company.atlassian.net). - Start date: The earliest timestamp used for incremental extraction.
- Project keys: Optional list of project keys to scope extraction. When defined, project-dependent streams are filtered to those projects.
- Issues stream JQL query: Optional custom JQL filter for the
issuesstream. It is combined with the start date filter and project filter.
2. Select streams
Choose which Jira streams you want to sync. For faster extractions, select only the streams required for your use case.Tip: You can search for a stream by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how each stream table will be created in your Catalog:- Layer: Select where the tables will be created.
- Folder: Optionally group generated tables under a folder.
- Table name: Use suggested names or customize them (you can apply a prefix to all tables).
- Sync Type: Choose
INCREMENTALorFULL_TABLEaccording to your data strategy.
4. Configure data source
Add a source name and description for your team, then define a Trigger frequency. Optionally, configure:- Delta Log Retention: How long old table states should be retained. Learn more here.
- Additional Full Sync: Optional periodic full refresh to complement incremental runs.
5. Check your new source
After setup, you can monitor runs in Sources. Once at least one run succeeds, the resulting tables become available in Catalog.Streams and Fields
Below you’ll find all available data streams from Jira and their corresponding key fields.Projects
Projects
Base project entities used by other project-scoped streams.Primary key:
id
key- Project key used as Jira identifiername- Project nameproject_type_key- Project typeis_private- Project visibility flagproject_category- Project category metadatainsight.total_issue_count- Total number of issues
Boards
Boards
Agile boards associated with projects.Primary key:
id
projects(filtered by project context)
name- Board nametype- Board type (scrum,kanban, etc.)location.project_id- Related project IDlocation.project_key- Related project keylocation.project_name- Related project name
Sprints
Sprints
Sprint entities collected from agile boards.Replication key:
id
boards(only boards with typescrum)
state- Sprint statename- Sprint namestart_date- Sprint start dateend_date- Sprint end datecomplete_date- Completion dateboard_id- Parent board IDgoal- Sprint goal
Issue Types
Issue Types
Issue type definitions available per project.Primary key:
id
projects(filtered by project context)
name- Issue type namedescription- Issue type descriptionsubtask- Whether the type is a subtaskhierarchy_level- Hierarchy level in Jirascope.project.id- Project-scoped type project IDscope.project.key- Project-scoped type project key
Fields
Fields
Field definitions and metadata available for projects.Primary key:
id
projects(filtered by project context)
key- Field keyname- Field namecustom- Whether the field is customorderable- Whether the field can be used in orderingsearchable- Whether the field can be searchedschema.type- Data type for field valuesschema.custom- Custom schema identifier
Users
Users
Jira users available to the authenticated account.Primary key:
account_id
display_name- User display nameemail_address- User emailaccount_type- Account typeactive- Whether the user is activetime_zone- User time zonelocale- User locale
Issues
Issues
Main issue entities with detailed nested fields from Jira.Primary key:
id
updated
key- Issue keycreated- Issue creation timestampupdated- Last update timestampfields.summary- Issue summaryfields.status- Current issue statusfields.issuetype- Issue type detailsfields.project- Parent project detailsfields.assignee- Assignee detailsfields.reporter- Reporter detailsfields.labels- Labels array
Issue Changelog
Issue Changelog
Change history for each issue.Primary key:
id
created
issues
issue_id- Parent issue IDauthor.account_id- Author account IDcreated- Changelog creation timestampitems.field- Changed fielditems.from- Previous value IDitems.to- New value IDitems.from_string- Previous value (display)items.to_string- New value (display)
Data Model
The following diagram shows the relationship between the main Jira streams.Implementation Notes
Filtering behavior
project_keyslimits project-scoped extraction to specific Jira projects.issuesalways applies anupdated >= start_datefilter, and can additionally apply a custom JQL query.- The final JQL for
issuescombines start date, optional project keys, and optional custom JQL with logicaland.
Stream hierarchy behavior
boards,fields, andissue_typesare project-scoped child streams.sprintsis collected only fromscrumboards.issue_changelogis collected per issue and includesissue_idas parent context.
Skills for agents
Download Jira skills file
Jira connector documentation as plain markdown, for use in AI agent contexts.