Skip to main content

Jira Connector

Jira Manage issues, comments, projects, and users in Jira.

Connections

Basic Authentication

Authenticate with Jira using username and API key

To authenticate with Atlassian Jira using Basic Authentication, an email address and either an API token (for Jira Cloud) or password (for self-hosted Jira) is required.

Prerequisites

  • Access to a Jira Cloud or self-hosted Jira instance
  • Administrative permissions to generate API tokens (for Jira Cloud)

Setup Steps

For Jira Cloud:

  1. Navigate to Atlassian Account API Tokens
  2. Click Create API token
  3. Enter a label for the token and click Create
  4. Copy the generated API token value

For Self-Hosted Jira:

Use the standard account password for authentication. No additional setup is required.

Configure the Connection

  • For Username, enter the email address associated with the Jira account
  • For API Key:
    • Jira Cloud: Enter the API token generated in the previous step
    • Self-Hosted Jira: Enter the account password
  • For Host, enter the Jira instance URL (e.g., example.atlassian.net for cloud or the self-hosted domain)
  • For Version, select the API version (typically 3 for Jira Cloud, 2 for older instances)

For more information on generating API tokens from Jira Cloud, refer to the Atlassian documentation.

Self-Hosted vs Cloud Authentication

Jira Cloud requires an API token for Basic Authentication, while self-hosted instances can use the account password. For security reasons, it is recommended to use API tokens whenever possible.

InputCommentsDefault
UsernameYour Jira username or email address used for authentication.
API KeyYour Jira API token for authentication. Cloud users must generate an API token from Atlassian Account Settings.
HostThe hostname of your Jira instance (without https://).
VersionSelect the Jira API version to use for requests.3

OAuth 2.0

Authenticate with Jira using OAuth 2.0 for secure access

To create an Atlassian Jira OAuth 2.0 connection, an OAuth 2.0 integration must be configured in the Atlassian Developer Console.

Jira's Cloud API supports OAuth 2.0 (3LO) flows for secure authentication. For more information on OAuth 2.0 (3LO) apps, refer to Jira's OAuth 2.0 documentation.

Prerequisites

Setup Steps

  1. Navigate to the Atlassian Developer Console
  2. Click Create and select OAuth 2.0 integration
  3. Enter a name for the integration
  4. After creation, locate the App details section and copy the Client ID and Client Secret values
  5. Under the Authorization section, click Configure next to OAuth 2.0 (3LO)
  6. Enter the callback URL: https://oauth2.integrations.acme.com/callback
  7. Navigate to the Permissions tab
  8. Add the required scopes based on the use case:
    • For basic issue management, the following scopes are recommended:
      read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
    • Refer to Jira OAuth 2.0 scopes documentation for a complete list of available scopes
  9. Click Save to apply the configuration
Scope Consistency

The scopes configured in the Atlassian Developer Console must match the scopes entered in the connection configuration. Inconsistent scopes will cause authentication failures.

Configure the Connection

  • Enter the Client ID from the Atlassian Developer Console

  • Enter the Client Secret from the Atlassian Developer Console

  • For Scopes, use the following default value:

    read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
    • The offline_access scope is required to obtain a refresh token
    • Customize the scopes to match the use case requirements
    • Ensure the scopes match those configured in the Atlassian Developer Console
    • Refer to Jira scopes documentation for additional scope information
  • For Jira Site Name (optional):

    • By default, the connection uses the first Jira site the authenticated user has access to
    • To specify a different site, enter the site name (e.g., example) or full URL (e.g., example.atlassian.net)
  • For Version, select the API version (typically 3 for Jira Cloud)

For additional information on developing Jira applications and OAuth 2.0 configuration, refer to the Jira OAuth 2.0 apps guide.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Jira.https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
Token URLThe OAuth 2.0 Token URL for Jira.https://auth.atlassian.com/oauth/token
ScopesSpace-delimited list of OAuth scopes for Jira access. For more information, see Jira OAuth 2.0 Scopes.read:jira-user read:jira-work write:jira-work manage:jira-project manage:jira-configuration manage:jira-webhook offline_access
Client IDYour OAuth 2.0 Client ID from the Atlassian Developer Console.
Client SecretYour OAuth 2.0 Client Secret from the Atlassian Developer Console.
Jira Site NameOptional site name or URL to connect to. By default, connects to the first Jira site the user has access to. Use this if you have multiple Jira sites.
VersionSelect the Jira API version to use for requests.3

Triggers

Issue Events

Receive real-time notifications when Jira issues are created, updated, or deleted. Automatically creates and manages a webhook subscription for selected issue events when the instance is deployed, and removes the subscription when the instance is deleted.

InputCommentsDefault
ConnectionThe Jira connection to use.
Event TypesSelect the Jira events that will trigger this webhook.
JQL FilterJQL (Jira Query Language) filter to limit which issues trigger the webhook. For more information, see JQL Documentation.
Field IDs FilterOptional list of field IDs to monitor. Only changes to these specific fields will trigger the webhook. Leave empty to monitor all field changes.

Actions

Add Comment

Add a comment to an existing issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
CommentThe text content of the comment to add or update.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Add Issue Attachment

Add a file attachment to an issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
FileThe file to upload - either string contents or a binary file
File NameThe name of the file to upload

Create Issue

Create an issue within a given project

InputCommentsDefault
ConnectionThe Jira connection to use.
Project IDThe unique identifier or name of the Jira project.
SummaryA brief summary or title for the issue.
DescriptionA detailed description of the issue.
ADF DescriptionThe above json code will print: 'Some text' in the Jira Issue description, to get more info visit: https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/ to get a JSON representation of your description.
{
"version": 1,
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Some text"
}
]
}
]
}
Issue Type NameProvide a value for the name type of the issue. Use this field or the Issue Type ID field.
Issue Type IDProvide the ID of the Issue Type. Use this field or the Issue Type Name field.
Assignee Account IDThe Atlassian account ID of the user to assign the issue to.
Reporter Account IDThe Atlassian account ID of the user reporting the issue.
Due DateProvide due date for the issue.
PriorityProvide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.
LabelsProvide a list of labels for the issue.
VersionsProvide JSON data for the versions. You must supply a JSON array with an object containing an Id.
Fix VersionsProvide JSON data for the fix versions. Your object must have a property 'id'
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Create User

Create a new user record

InputCommentsDefault
ConnectionThe Jira connection to use.
Email AddressProvide a string value for a valid email address.
UsernameThe username for the Jira user account.
PasswordThe password to assign to the user account.
NotificationsWhen true, the user will receive email notifications for relevant events.false
Display NameThe display name for the user account.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Create Version

Create a new version

InputCommentsDefault
ConnectionThe Jira connection to use.
DescriptionA detailed description of the issue.
Version NameProvide a string value for the name of the version.
ArchivedWhen true, marks the version as archived.false
ReleasedWhen true, marks the version as released.false
Start DateProvide a value for the startDate.
Release DateProvide a valid date for the release of the given version.
Project KeyThe project key identifier (e.g., PROJ, ENG, SALES).
Project IDThe unique identifier or name of the Jira project.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Create Webhook

Create a webhook to send data from Jira to an instance URL

InputCommentsDefault
ConnectionThe Jira connection to use.
Webhook URLReference a flow's URL from the trigger payload
Webhook DetailsWebhook Details payload to be sent into Jira's OAuth2 Webhook API or Jira's REST API; must match structure of webhooks property for Register Dynamic Webhook endpoint: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-post

Delete Comment

Delete a comment from an issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
Comment IDThe unique identifier of the comment.

Delete Issue

Delete an issue by id

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.

Delete Webhook

Delete a webhook by ID

InputCommentsDefault
ConnectionThe Jira connection to use.
Webhook IDThe ID of the webhook to remove

Download Issue Attachments

Download the attachments data connected to an issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDProviding an Issue ID will return all attachments of an Issue.
Attachment IDsThe IDs of the attachments to download. If this field is provided, the issue id input will be ignored.

Find Issue

Find Issue by attribute

InputCommentsDefault
ConnectionThe Jira connection to use.
Search TypeAttribute to search
Search ValueValue to search for
FieldsComma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

Find Project

Find Project by attribute

InputCommentsDefault
ConnectionThe Jira connection to use.
Search TypeAttribute to search
Search ValueValue to search for

Find User

Find User by attribute

InputCommentsDefault
ConnectionThe Jira connection to use.
Search ValueValue to search for

Get Board

Get information and metadata of a board by Id

InputCommentsDefault
ConnectionThe Jira connection to use.
Board IDThe unique identifier of the Jira board.

Get Comments

Get all the comments on a given issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.

Get Current User

Get the information and metadata of the current user

InputCommentsDefault
ConnectionThe Jira connection to use.

Get Issue

Get the information and metadata of an issue

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.

Get Project

Get the information and metadata of a project

InputCommentsDefault
ConnectionThe Jira connection to use.
Project IDThe unique identifier or name of the Jira project.

Get Status List

Returns a status list

InputCommentsDefault
ConnectionThe Jira connection to use.
Project IDThe unique identifier or name of the Jira project.
Max ResultsThe maximum number of results to return per page.
Start AtThe index of the first item to return in the result set (0-based).0

Get User

Get information and metadata about an user by id

InputCommentsDefault
ConnectionThe Jira connection to use.
Account IDThe unique Atlassian account ID of the user.
ExpandThe response may contain a list under the _expandable property; you can specify any of its values separated by commas.

Get Version

Get the information and metadata of an existing version

InputCommentsDefault
ConnectionThe Jira connection to use.
Version IDThe unique identifier of the version.

List Assignable Users for Project

Returns a list of users assignable to the given project

InputCommentsDefault
ConnectionThe Jira connection to use.
Project KeyThe project key identifier (e.g., PROJ, ENG, SALES).
Start AtThe index of the first item to return in the result set (0-based).0
Max ResultsThe maximum number of results to return per page.

List Boards

Retrieve a list of existing boards

InputCommentsDefault
ConnectionThe Jira connection to use.
Start AtThe index of the first item to return in the result set (0-based).0
Max ResultsThe maximum number of results to return per page.
FilterThe filter applied to the list of dashboards.my

List Board Sprints

List all sprints within a board

InputCommentsDefault
ConnectionThe Jira connection to use.
Board IDThe unique identifier of the Jira board.
Start AtThe index of the first item to return in the result set (0-based).0
Max ResultsThe maximum number of results to return per page.

List Issue Attachments

Returns a list of issue attachments

InputCommentsDefault
Issue IDThe unique identifier of the Jira issue.
ConnectionThe Jira connection to use.

List Issue Custom Fields

List all configured issue fields

InputCommentsDefault
ConnectionThe Jira connection to use.

List Issue Fields

List all non-custom issue fields

InputCommentsDefault
ConnectionThe Jira connection to use.

List Issue Link Types

List all available issue link types

InputCommentsDefault
ConnectionThe Jira connection to use.

List Issues by Project

Returns a list of issues for a specific project

InputCommentsDefault
ConnectionThe Jira connection to use.
Project IDThe unique identifier or name of the Jira project.
Next Page TokenToken for cursor-based pagination. Use the token returned from the previous response to get the next page of results. Leave empty for the first page.
Max ResultsThe maximum number of results to return per page.
FieldsComma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

List Issue Transitions

Returns a list of issue transitions

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.

List Issue Types

Returns a list of issue types

InputCommentsDefault
ConnectionThe Jira connection to use.

List Issue Worklogs

Returns a list of issue worklogs

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.

List Priorities

Returns a list of all priorities

InputCommentsDefault
ConnectionThe Jira connection to use.
Max ResultsThe maximum number of results to return per page.
Start AtThe index of the first item to return in the result set (0-based).0

List Projects

Retrieve a list of all projects

InputCommentsDefault
ConnectionThe Jira connection to use.
Max ResultsThe maximum number of results to return per page.
Start AtThe index of the first item to return in the result set (0-based).0

List Versions

Returns a list of all versions

InputCommentsDefault
ConnectionThe Jira connection to use.
Project IDThe unique identifier or name of the Jira project.
Max ResultsThe maximum number of results to return per page.
Start AtThe index of the first item to return in the result set (0-based).0

List Webhooks

List all webhooks configured, including those for other integrations

InputCommentsDefault
ConnectionThe Jira connection to use.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false

Query

Search your entire Jira site using a JQL query.

InputCommentsDefault
ConnectionThe Jira connection to use.
SearchThe search term to use when searching for records.
ExpandThe response may contain a list under the _expandable property; you can specify any of its values separated by commas.
Max ResultsThe maximum number of results to return per page.

Raw Request

Send raw HTTP request to Jira

InputCommentsDefault
ConnectionThe Jira connection to use.
URLInput the path only (/rest/api/3/project/recent), The base URL is already included (https://api.atlassian.com/ex/jira/<CLOUD_ID>). For example, to connect to https://api.atlassian.com/ex/jira/<CLOUD_ID>/rest/api/3/project/recent, only /rest/api/3/project/recent is entered in this field./rest/api/3/project/recent
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Refresh Webhook

Refresh webhook expiration by ID

InputCommentsDefault
ConnectionThe Jira connection to use.
Webhook IDID of the webhook to refresh

Search Issues

Returns a list of issues that match the given string of text

InputCommentsDefault
ConnectionThe Jira connection to use.
SearchThe search term to use when searching for records.
Project KeyThe project key identifier (e.g., PROJ, ENG, SALES).
FieldsComma-separated list of fields to return. Defaults to common navigable fields (summary, status, assignee, reporter, priority, issuetype, project, created, updated). Use '*all' for all fields or specify individual field names.

Search Projects

Returns a list of projects that match the given string of text

InputCommentsDefault
ConnectionThe Jira connection to use.
SearchThe search term to use when searching for records.

Search Users

Returns a single user that matches the given string of text

InputCommentsDefault
ConnectionThe Jira connection to use.
SearchThe search term to use when searching for records.

Transition Issue

Transition an existing issue by Id

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
Transition IDThe unique identifier of the issue transition.

Update Comment

Update the contents and metadata of an existing comment.

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
Comment IDThe unique identifier of the comment.
CommentThe text content of the comment to add or update.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Update Issue

Update an existing issue within a given project

InputCommentsDefault
ConnectionThe Jira connection to use.
Issue IDThe unique identifier of the Jira issue.
Project IDThe unique identifier or name of the Jira project.
SummaryA brief summary or title for the issue.
DescriptionA detailed description of the issue.
ADF DescriptionThe above json code will print: 'Some text' in the Jira Issue description, to get more info visit: https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/ to get a JSON representation of your description.
{
"version": 1,
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Some text"
}
]
}
]
}
Issue Type NameProvide a value for the name type of the issue. Use this field or the Issue Type ID field.
Issue Type IDProvide the ID of the Issue Type. Use this field or the Issue Type Name field.
Assignee Account IDThe Atlassian account ID of the user to assign the issue to.
Reporter Account IDThe Atlassian account ID of the user reporting the issue.
Fix VersionsProvide JSON data for the fix versions. Your object must have a property 'id'
PriorityProvide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.
LabelsProvide a list of labels for the issue.
Due DateProvide due date for the issue.
VersionsProvide JSON data for the versions. You must supply a JSON array with an object containing an Id.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record

Update Version

Update an existing version by Id

InputCommentsDefault
ConnectionThe Jira connection to use.
Version IDThe unique identifier of the version.
DescriptionA detailed description of the issue.
Version NameProvide a string value for the name of the version.
ArchivedWhen true, marks the version as archived.false
ReleasedWhen true, marks the version as released.false
Start DateProvide a value for the startDate.
Release DateProvide a valid date for the release of the given version.
Project KeyThe project key identifier (e.g., PROJ, ENG, SALES).
Project IDThe unique identifier or name of the Jira project.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
ValuesThe names of the fields and their values to use when creating/updating a record