Jira

This connector captures data from Jira 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: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.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system.

You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources

The following data resources are supported through the Jira APIs:

• Application roles
• Avatars
• Boards
• Dashboards
• Filters
• Filter sharing
• Groups
• Issue fields
• Issue field configurations
• Issue custom field contexts
• Issue link types
• Issue navigator settings
• Issue notification schemes
• Issue priorities
• Issue properties
• Issue remote links
• Issue resolutions
• Issue security schemes
• Issue type schemes
• Issue type screen schemes
• Issue votes
• Issue watchers
• Jira settings
• Labels
• Permissions
• Permission schemes
• Projects
• Project avatars
• Project categories
• Project components
• Project email
• Project permission schemes
• Project types
• Project versions
• Screens
• Screen tabs
• Screen tab fields
• Screen schemes
• Sprints
• Time tracking
• Users
• UsersGroupsDetailed
• Workflows
• Workflow schemes
• Workflow statuses
• Workflow status categories
• Board issues
• Issue comments
• Issue worklogs
• Issues
• Sprint issues By default, each resource is mapped to a Flow collection through a separate binding.

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

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:dev
        config:
          api_token: <token>
          domain: <domain>
          email: <email>
    bindings:
      - resource:
          stream: issues
          syncMode: incremental
        target: ${PREFIX}/issues
      {...}