jira-native.md

Jira

This connector captures data from Jira's REST API into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-jira-native:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

Supported data resources

The following data resources are supported through the Jira APIs:

• Application roles
• Avatars
• Boards
• Board issues
• Dashboards
• Filters
• Filter sharing
• Groups
• Issues
• Issue comments
• Issue fields
• Issue field configurations
• Issue custom field contexts
• Issue custom field options
• Issue link types
• Issue navigator settings
• Issue notification schemes
• Issue priorities
• Issue properties
• Issue remote links
• Issue resolutions
• Issue security schemes
• Issue transitions
• Issue types
• Issue type schemes
• Issue type screen schemes
• Issue votes
• Issue watchers
• Issue worklogs
• Jira settings
• Labels
• Permissions
• Permission schemes
• Projects
• Project avatars
• Project categories
• Project components
• Project email
• Project permission schemes
• Project roles
• Project types
• Project versions
• Screens
• Screen tabs
• Screen tab fields
• Screen schemes
• Sprints
• Sprint issues
• Time tracking
• Users
• UsersGroupsDetailed
• Workflows
• Workflow schemes
• Workflow statuses
• Workflow status categories

By default, each resource is mapped to a Flow collection through a separate binding.

Experimental streams

These resources are not documented by Jira and must specifically be enabled in the connector configuration.

• Pull Requests (GitHub pull requests linked to issues)

Prerequisites

• API Token: You can create an API token following these steps from Jira
• Domain
• Email

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Jira source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/api_token	API Token	Jira API Token is used for Authorization to your account by BasicAuth.	string	Required
/domain	Domain	The Domain for your Jira account, e.g. estuary.atlassian.net, estuary.jira.com, jira.your-domain.com	string	Required
/email	Email	The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.	string	Required
/projects	Projects	List of Jira project keys to replicate data for. Leave it empty to replicate data for all projects.	string[]
/start_date	Start Date	UTC date-time in the format YYYY-MM-DDT00:00:00Z. Data generated before this date will not be replicated. Note that this field only applies to certain streams.	string
/lookback_window_minutes	Lookback Window	When set to N, the connector will always refresh resources created within the past N minutes.	integer	0
/enable_experimental_streams	Enable Experimental Streams	Allow the use of experimental streams which rely on undocumented Jira API endpoints. See experimental streams above.	boolean	false
/expand_issue_changelog	Expand Issue Changelog	(Deprecated) Expand the changelog when replicating issues. See issues_stream_expand_with for a newer implementation.	boolean	false
/render_fields	Render Issue Fields	(Deprecated) Render issue fields in HTML format in addition to Jira JSON-like format. See issues_stream_expand_with for a newer implementation.	boolean	false
/expand_issue_transition	Expand Issue Transitions	(Deprecated) Expand the transitions when replicating issues. See issues_stream_expand_with for a newer implementation.	boolean	false
/issues_stream_expand_with	Expand Issues Stream	Array that compiles issue expansion options. The array can include these enum values: renderedFields, transitions, changelog.	string[]	[]

Bindings

Property	Title	Description	Type	Required/Default
/stream	Stream	Resource of your Jira project from which collections are captured.	string	Required
/syncMode	Sync Mode	Connection method.	string	Required

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-jira-native:dev
        config:
          api_token: <token>
          domain: <domain>
          email: <email>
          start_date: 2025-01-01T00:00:00Z
          lookback_window_minutes: 60
          enable_experimental_streams: false
          issues_stream_expand_with:
            - renderedFields
            - transitions
    bindings:
      - resource:
          stream: issues
          syncMode: incremental
        target: ${PREFIX}/issues
      {...}