Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nekt.com/llms.txt

Use this file to discover all available pages before exploring further.

Jira is Atlassian’s project management and issue tracking platform designed for software development teams. It provides tools for agile project management, bug tracking, and workflow automation to help teams plan, track, and release software efficiently. Jira

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 issues stream. It is combined with the start date filter and project filter.
Once you’re done, click Next.

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 INCREMENTAL or FULL_TABLE according to your data strategy.
Once you finish this step, click Next.

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.
When ready, click Next to complete the setup.

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.
For you to be able to see the extracted tables on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Jira and their corresponding key fields.
Base project entities used by other project-scoped streams.Primary key:
  • id
Key Fields:
FieldTypeDescription
keyStringProject key used as Jira identifier
nameStringProject name
project_type_keyStringProject type
is_privateBooleanProject visibility flag
project_categoryObjectProject category metadata
insight.total_issue_countIntegerTotal number of issues
Agile boards associated with projects.Primary key:
  • id
Parent stream:
  • projects (filtered by project context)
Key Fields:
FieldTypeDescription
nameStringBoard name
typeStringBoard type (scrum, kanban, etc.)
location.project_idStringRelated project ID
location.project_keyStringRelated project key
location.project_nameStringRelated project name
Sprint entities collected from agile boards.Replication key:
  • id
Parent stream:
  • boards (only boards with type scrum)
Key Fields:
FieldTypeDescription
stateStringSprint state
nameStringSprint name
start_dateStringSprint start date
end_dateStringSprint end date
complete_dateStringCompletion date
board_idStringParent board ID
goalStringSprint goal
Issue type definitions available per project.Primary key:
  • id
Parent stream:
  • projects (filtered by project context)
Key Fields:
FieldTypeDescription
nameStringIssue type name
descriptionStringIssue type description
subtaskBooleanWhether the type is a subtask
hierarchy_levelIntegerHierarchy level in Jira
scope.project.idStringProject-scoped type project ID
scope.project.keyStringProject-scoped type project key
Field definitions and metadata available for projects.Primary key:
  • id
Parent stream:
  • projects (filtered by project context)
Key Fields:
FieldTypeDescription
keyStringField key
nameStringField name
customBooleanWhether the field is custom
orderableBooleanWhether the field can be used in ordering
searchableBooleanWhether the field can be searched
schema.typeStringData type for field values
schema.customStringCustom schema identifier
Jira users available to the authenticated account.Primary key:
  • account_id
Key Fields:
FieldTypeDescription
display_nameStringUser display name
email_addressStringUser email
account_typeStringAccount type
activeBooleanWhether the user is active
time_zoneStringUser time zone
localeStringUser locale
Main issue entities with detailed nested fields from Jira.Primary key:
  • id
Replication key:
  • updated
Key Fields:
FieldTypeDescription
keyStringIssue key
createdStringIssue creation timestamp
updatedStringLast update timestamp
fields.summaryStringIssue summary
fields.statusObjectCurrent issue status
fields.issuetypeObjectIssue type details
fields.projectObjectParent project details
fields.assigneeObjectAssignee details
fields.reporterObjectReporter details
fields.labelsArrayLabels array
Change history for each issue.Primary key:
  • id
Replication key:
  • created
Parent stream:
  • issues
Key Fields:
FieldTypeDescription
issue_idStringParent issue ID
author.account_idStringAuthor account ID
createdStringChangelog creation timestamp
items.fieldStringChanged field
items.fromStringPrevious value ID
items.toStringNew value ID
items.from_stringStringPrevious value (display)
items.to_stringStringNew value (display)

Data Model

The following diagram shows the relationship between the main Jira streams.

Implementation Notes

Filtering behavior

  • project_keys limits project-scoped extraction to specific Jira projects.
  • issues applies an updated >= start_date filter if a starting timestamp is available, and can additionally apply a custom JQL query.
  • The final JQL for issues combines the start date (if present), optional project keys, and optional custom JQL with logical and.

Stream hierarchy behavior

  • boards, fields, and issue_types are project-scoped child streams.
  • sprints is collected only from scrum boards.
  • issue_changelog is collected per issue and includes issue_id as parent context.

Skills for agents

Download Jira skills file

Jira connector documentation as plain markdown, for use in AI agent contexts.