Jira Component

Manage Jira issues, comments, projects and users

Component key: atlassian-jira

Description

Jira is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management. This component allows you to create, update, comment on, and delete issues in a Jira project.

API Documentation

This component was built using the JIRA API Documentation

Connections

Jira Basic Connection

If you select Basic Auth and you are using Jira Cloud, you will need to supply your Jira email and an API token to the connection. If you are on a locally hosted instance of Jira, you will need to supply your Jira email and password to the connection. For information on generating an API token from Jira Cloud, refer to the Atlassian docs.

Input	Default	Notes	Example
Host string / Required host		Provide a string value for the URL of your Jira account.	example.atlassian.net
API Key string / Required password		Provide an api token to authenticate all requests with. Cloud users need to generate an API token for this value.	exampleSecurePassword
Username string / Required username		Provide a valid username for the given jira account you want to connect.	exampleUser
Version string / Required version	3	Select an API version for your Jira API request

Jira OAuth 2.0 Connection

While Jira's Cloud API has support for legacy OAuth 1.0, Prismatic only offers support for Jira's OAuth 2.0 (3LO) flows. If you select OAuth 2.0, you need to enable it for your app using the Atlassian developer console.

Create a new "Oauth 2.0 integration" and give it a name.
Under the app details section, take note of your client Id and client secret values that were generated.
After you have saved those values, find the Authorization section and click configure on Oauth 2.0 (3LO).
You will now be prompted to enter your redirect URL as https://oauth2.prismatic.io/callback for US based integrations.
1. For integrations outside the US refer to this guide to find your region’s Callback URL.
Next, navigate to the permissions. It is important that you remain consistent with the scopes you supply in both Jira, and your Prismatic connection.
The default scopes on a new connection in Prismatic will be as follows:
1. read:project:jira read:user:jira write:issue:jira read:issue:jira read:issue-link:jira write:issue-link:jira read:issue-link-type:jira write:issue-link-type:jira read:issue.transition:jira delete:issue:jira
2. These scopes will provide access to the most of the actions in the Jira component, but you may have to modify the scopes in both locations (Prismatic and Atlassian Console) to meet your needs.
For more information on developing Jira applications, follow the guide here.
Next, configure an OAuth 2.0 connection within Prismatic.
Add a Jira step to your integration.
1. This will automatically create a Jira connection config variable.
Ensure the connection is of type Jira OAuth 2.0 Connection and enter the following details:
For Client ID and Client Secret enter the values that you got from the Atlassian Developer Console
As stated previously Scopes will default to the following:
1. read:project:jira read:user:jira write:issue:jira read:issue:jira read:issue-link:jira write:issue-link:jira read:issue-link-type:jira write:issue-link-type:jira read:issue.transition:jira delete:issue:jira.
With the addition of offline_access on the connection side to obtain a refresh token. From here you can do any additional configuration to match your use case. For example, you might assign the scopes manage:jira-project read:jira-user if you plan to work with Users and Projects. You will need to enable these scopes on the Atlassian Developer Console page for your OAuth 2.0 Jira app. It is important to include offline_access in your scopes, or you will not be given a refresh token.
For Version enter the version of Jira you use (you likely use version 2).
1. Jira API: manage:jira-configuration, manage:jira-project, write:jira-work, read:jira-work.

Input	Default	Notes	Example
Jira Site Name string apiSiteOverride		By default this connector connects to the first Jira site this user has access to. If you have multiple Jira sites, please specify which one you would like to connect to, you can use the site name or the full url.	example or https://example.atlassian.net
Authorize URL string / Required authorizeUrl	https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent	The OAuth 2.0 Authorization URL for Jira
Client ID string / Required clientId			c9e4APadFFkbtTycoNtrHKBtYgUyZWy
Client Secret password / Required clientSecret			ntDBx4ao5czkFu7Mzp5FTlYG0y3_ukxkSiPhwnTkhsdKHJITGRCGP3ZWlXTYyu
Scopes string / Required scopes	read:project:jira read:user:jira write:issue:jira read:issue:jira read:issue-link:jira write:issue-link:jira read:issue-link-type:jira write:issue-link-type:jira read:issue.transition:jira delete:issue:jira offline_access	A space-delimited set of one or more scopes to get the user's permission to access.
Token URL string / Required tokenUrl	https://auth.atlassian.com/oauth/token	The OAuth 2.0 Token URL for Jira
Version string / Required version	3	Select an API version for your Jira API request

Data Sources

Issue Fields

A map of a list of fields to Jira Issue Fields. | key: issueFields | type: picklist

Input	Default	Notes
Connection connection / Required connection
Only Custom Fields boolean onlyCustomFields	false

Select Issue Type

Select an issue type | key: selectIssueType | type: picklist

Input	Default	Notes	Example
Connection connection / Required connection
Project ID(s) string / Required projectIds		Provide one or more Project IDs.	10201
Issue Type Return string / Required returnIssueTypeName	false	Select whether to return the Issue Type ID or Name.

Select Issue Types

Select one or many Issue Types | key: selectIssueTypes | type: objectSelection

Input	Notes	Example
Connection connection / Required connection
Project ID(s) string / Required projectIds	Provide one or more Project IDs.	10201

Select Project

Select a project | key: selectProject | type: picklist

Input	Notes
Connection connection / Required connection

Select Projects

Select one or many projects | key: selectProjects | type: objectSelection

Input	Notes
Connection connection / Required connection

Actions

Add Comment

Add a comment to an existing issue | key: addComment

Input	Default	Notes	Example
Comment string / Required comment		Provide a string value for the comment.	This is an example comment.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Add Issue Attachment

Add a file attachment to an issue | key: addIssueAttachment

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
File data / Required file		The file to upload - either string contents or a binary file
File Name string / Required fileName		The name of the file to upload
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Create Issue

Create an issue within a given project | key: createIssue

Input	Default	Notes	Example
ADF Description code ADFdescription		The 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.
Assignee Account ID string assignee		Provide the Account ID for the person being assigned the issue.	b7b399c5b7c40279d7211271
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Provide a string value for the description of the issue.	This is an example summary.
Due Date string dueDate		Provide due date for the issue.	2019-05-11
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Fix Versions code fixVersions		Provide JSON data for the fix versions. Your object must have a property 'id'
Issue Type Name string issueType		Provide a value for the name type of the issue. Use this field or the Issue Type ID field.	Task
Issue Type ID string issueTypeId		Provide the ID of the Issue Type. Use this field or the Issue Type Name field.	10001
Connection connection / Required jiraConnection
Labels string Value List labels		Provide a list of labels for the issue.	performance
Priority string priority		Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.	High
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Reporter Account ID string reporter		Provide the Account ID for the person that is reporting the issue.	b7b399c5b7c40279d7211271
Summary string / Required summary		Provide a string value for the summary of the issue.	This is an example summary.
Versions code versions		Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.

Create User

Create a new user record | key: createUser

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Display Name string displayName		Provide a string value for the display name to assign to the new user.	John Doe
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address string / Required emailAddress		Provide a string value for a valid email address.	someone@example.com
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Connection connection / Required jiraConnection
Notifications boolean / Required notifications	false	This flag will determine if the user will receive notifications.
Password string / Required password		Provide a password to assign to the user.	superSecretPassword
Username string / Required username		Provide a string value for the username of the user.	Example User

Create Version

Create a new version | key: createVersion

Input	Default	Notes	Example
Archived boolean archived	false	This flag determines if the given version is archived.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Provide a string value for the description of the issue.	This is an example summary.
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Connection connection / Required jiraConnection
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Project Key string projectKey		Provide a string value for the key of the project.	JS-Example
Released boolean released	false	This flag determines if the given version has been released.
Release Date string releaseDate		Provide a valid date for the release of the given version.	2021-07-22
Start Date string startDate		Provide a value for the startDate.	2021-07-22
Version Name string / Required versionName		Provide a string value for the name of the version.	2019.08.18

Example Payload for Create Version

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
    "id": "10000",
    "description": "An excellent version",
    "name": "New Version 1",
    "archived": false,
    "released": true,
    "releaseDate": "2010-07-06",
    "userReleaseDate": "6/Jul/2010",
    "project": "PXA",
    "projectId": 10000
  }
}

Create Webhook

Create a webhook to send data from Jira to an instance URL | key: createWebhook

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Webhook Details code webhookDetails		Webhook 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
Webhook URL string / Required webhookUrl		Reference a flow's URL from the trigger payload

Registering a Dynamic Webhook requires supplying a highly configurable payload called "Webhook Details". It's important to configure this for all use cases as each Jira app is only permitted to create and manage one endpoint.

Registering a Webhook Notes

Please note that whenever trying to register a webhook, the request payload's structure is different depending on the authentication method:

For Basic Auth, the payload should be structured as follows on this article: Basic Auth Webhook Payload Structure

{
  "name": "my first webhook via rest",
  "description": "description of my first webhook",
  "events": [
    "jira:issue_created",
    "jira:issue_updated"
  ],
  "filters": {
    "issue-related-events-section": "Project = JRA AND resolution = Fixed"
  },
  "excludeBody" : false,
  "secret" : "G8j4166a5OkXRD4WbqV3"
}

For OAuth, the payload should be structured as follows: OAuth Webhook Payload Structure

[
  {
    "events": ["jira:issue_created", "jira:issue_updated"],
    "fieldIdsFilter": ["summary", "customfield_10029"],
    "jqlFilter": "project = PROJ"
  },
  {
    "events": ["jira:issue_deleted"],
    "jqlFilter": "project IN (PROJ, EXP) AND status = done"
  },
  {
    "events": ["issue_property_set"],
    "issuePropertyKeysFilter": ["my-issue-property-key"],
    "jqlFilter": "project = PROJ"
  }
]

Example Payload for Create Webhook

{
  "data": {
    "webhookRegistrationResult": [
      {
        "createdWebhookId": 7
      }
    ]
  }
}

Delete Comment

Delete a comment from an issue | key: deleteComment

Input	Default	Notes	Example
Comment ID string / Required commentId		Provide the Comment ID.	10201
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Delete Issue

Delete an issue by id | key: deleteIssue

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Webhook ID string / Required webhookId		THe ID of the webhook to remove

Example Payload for Delete Webhook

{
  "data": null
}

Download Issue Attachment

Download the attachment data connected to an issue | key: downloadAttachment

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Find Issue

Find Issue by attribute | key: findIssue

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Search Type string / Required searchType		Attribute to search
Search Value string / Required searchValue		Value to search for

Find Project

Find Project by attribute | key: findProject

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Search Type string / Required searchType		Attribute to search
Search Value string / Required searchValue		Value to search for

Find User

Find User by attribute | key: findUser

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Search Value string / Required searchValue		Value to search for

Get Board

Get information and metadata of a board by Id | key: getBoard

Input	Default	Notes	Example
Board ID string / Required boardId		Provide the ID of the Board.	10201
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

Example Payload for Get Board

{
  "data": {
    "id": 84,
    "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
    "name": "scrum board",
    "type": "scrum",
    "location": {
      "projectId": 10040,
      "userId": 10040,
      "userAccountId": "5b10a2844c20165700ede21g",
      "displayName": "Example Project",
      "projectName": "Example Project",
      "projectKey": "Example Project Key",
      "projectTypeKey": "KEY",
      "name": "Example Project"
    }
  }
}

Get Comments

Get all the comments on a given issue | key: getComments

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Example Payload for Get Comments

{
  "data": {
    "data": {
      "startAt": 0,
      "maxResults": 1,
      "total": 1,
      "comments": [
        {
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          "id": "10000",
          "author": {
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
            "accountId": "5b10a2844c20165700ede21g",
            "displayName": "Mia Krystof",
            "active": false
          },
          "body": {
            "type": "doc",
            "version": 1,
            "content": [
              {
                "type": "paragraph",
                "content": [
                  {
                    "type": "text",
                    "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                  }
                ]
              }
            ]
          },
          "updateAuthor": {
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
            "accountId": "5b10a2844c20165700ede21g",
            "displayName": "Mia Krystof",
            "active": false
          },
          "created": "2021-01-17T12:34:00.000+0000",
          "updated": "2021-01-18T23:45:00.000+0000",
          "visibility": {
            "type": "role",
            "value": "Administrators",
            "identifier": "Administrators"
          }
        }
      ]
    }
  }
}

Get Current User

Get the information and metadata of the current user | key: getCurrentUser

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

Get Issue

Get the information and metadata of an issue | key: getIssue

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Get Project

Get the information and metadata of a project | key: getProject

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201

Get Status List

Returns a status list | key: getStatusList

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Get User

Get information and metadata about an user by id | key: getUser

Input	Default	Notes	Example
Account ID string / Required accountId		Provide the Account ID of the account to use.	b7b399c5b7c40279d7211271
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Expand string expand		The response may contain a list under the _expandable property; you can specify any of its values separated by commas.	body, version, history
Connection connection / Required jiraConnection

Get Version

Get the information and metadata of an existing version | key: getVersion

Input	Notes	Example
Connection connection / Required jiraConnection
Version ID string / Required versionId	Provide the ID of the Version.	10201

List Assignable Users

Returns a list of users assignable to projects & issues | key: listAssignableUsers

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Project Key string / Required projectKey		Provide a string value for the key of the project.	JS-Example
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Example Payload for List Assignable Users

{
  "data": [
    {
      "displayName": "exampleUser",
      "accountId": "example-483204",
      "accountType": "atlassian",
      "emailAddress": "someone@example.com",
      "active": true
    },
    {
      "displayName": "exampleUser",
      "accountId": "example-483204",
      "accountType": "atlassian",
      "emailAddress": "someone@example.com",
      "active": true
    }
  ]
}

List Board Sprints

List all sprints within a board | key: listBoardsSprints

Input	Default	Notes	Example
Board ID string / Required boardId		Provide the ID of the Board.	10201
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Example Payload for List Board Sprints

{
  "data": {
    "maxResults": 2,
    "startAt": 1,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "id": 37,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
        "state": "closed",
        "name": "sprint 1",
        "startDate": "2015-04-11T15:22:00.000+10:00",
        "endDate": "2015-04-20T01:22:00.000+10:00",
        "completeDate": "2015-04-20T11:04:00.000+10:00",
        "originBoardId": 5,
        "goal": "sprint 1 goal"
      },
      {
        "id": 72,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
        "state": "future",
        "name": "sprint 2",
        "goal": "sprint 2 goal"
      }
    ]
  }
}

List Boards

Retrieve a list of existing boards | key: listBoards

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Filter string / Required filter		The filter applied to the list of dashboards.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Example Payload for List Boards

{
  "data": {
    "maxResults": 2,
    "startAt": 1,
    "total": 5,
    "isLast": false,
    "values": [
      {
        "id": 84,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
        "name": "scrum board",
        "type": "scrum"
      },
      {
        "id": 92,
        "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
        "name": "kanban board",
        "type": "kanban"
      }
    ]
  }
}

List Issue Custom Fields

List all configured issue fields | key: listIssueCustomFields

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

Example Payload for List Issue Custom Fields

{
  "data": [
    {
      "clauseNames": [],
      "custom": true,
      "id": "statuscategorychangedate",
      "key": "statuscategorychangedate",
      "name": "Status Category Changed",
      "navigable": true,
      "orderable": false,
      "schema": {
        "type": "datetime",
        "system": "statuscategorychangedate"
      },
      "searchable": true
    }
  ]
}

List Issue Fields

List all non-custom issue fields | key: listIssueFields

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

Example Payload for List Issue Fields

{
  "data": [
    {
      "id": "description",
      "name": "Description",
      "custom": false,
      "orderable": true,
      "navigable": true,
      "searchable": true,
      "clauseNames": [
        "description"
      ],
      "schema": {
        "type": "string",
        "system": "description"
      }
    },
    {
      "id": "summary",
      "key": "summary",
      "name": "Summary",
      "custom": false,
      "orderable": true,
      "navigable": true,
      "searchable": true,
      "clauseNames": [
        "summary"
      ],
      "schema": {
        "type": "string",
        "system": "summary"
      }
    }
  ]
}

List Issue Link Types

List all available issue link types | key: listIssueLinkTypes

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

List Issue Transitions

Returns a list of issue transitions | key: listIssueTransitions

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

List Issue Types

Returns a list of issue types | key: listIssueTypes

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

List Issue Worklogs

Returns a list of issue worklogs | key: listIssueWorklogs

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

List Issues

Returns a list of issues | key: listIssues

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

List Priorities

Returns a list of all priorities | key: listPriorities

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

List Projects

Retrieve a list of all projects | key: listProjects

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

List Versions

Returns a list of all versions | key: listVersions

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Example Payload for List Versions

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
    "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
    "maxResults": 2,
    "startAt": 0,
    "total": 7,
    "isLast": false,
    "values": [
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
        "id": "10000",
        "description": "An excellent version",
        "name": "New Version 1",
        "archived": false,
        "released": true,
        "releaseDate": "2010-07-06",
        "overdue": true,
        "userReleaseDate": "6/Jul/2010",
        "projectId": 10000
      },
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/version/10010",
        "id": "10010",
        "description": "Minor Bugfix version",
        "name": "Next Version",
        "archived": false,
        "released": false,
        "overdue": false,
        "projectId": 10000,
        "issuesStatusForFixVersion": {
          "unmapped": 0,
          "toDo": 10,
          "inProgress": 20,
          "done": 100
        }
      }
    ]
  }
}

List Webhooks

List all webhooks configured, including those for other integrations | key: listWebhooks

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection

Example Payload for List Webhooks

{
  "data": {
    "isLast": true,
    "maxResults": 100,
    "startAt": 0,
    "total": 1,
    "values": [
      {
        "events": [
          "jira:issue_created"
        ],
        "expirationDate": "2022-12-18T15:22:13.418-0900",
        "id": 1,
        "jqlFilter": "project = EXAMPLE"
      }
    ]
  }
}

Query

Search your entire Jira site using a JQL query | key: query

Input	Default	Notes	Example
Expand string expand		The response may contain a list under the _expandable property; you can specify any of its values separated by commas.	body, version, history
Connection connection / Required jiraConnection
Max Results string maxResults		Provide a value for the maximum amount of results to be returned in the request.	50
Search string / Required searchString		Provide a string value to search on.	status IN ("To Do", "In Progress", "Closed")
Start At string startAt	0	Provide the index of the first item to return (to start from)	3

Raw Request

Send raw HTTP request to Jira | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A 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.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url	/rest/api/3/project/recent	Input 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.	/sobjects/Account
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Refresh Webhook

Refresh webhook expiration by ID | key: refreshWebhook

Input	Default	Notes
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Webhook ID string / Required webhookId		THe ID of the webhook to remove

Example Payload for Refresh Webhook

{
  "data": {
    "expirationDate": "2022-12-21T09:20:20.388-0900"
  }
}

Search Issues

Returns a list of issues that match the given string of text | key: searchIssues

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Project Key string projectKey		Provide a string value for the key of the project.	JS-Example
Search string / Required searchString		Provide a string value to search on.	Search

Search Projects

Returns a list of projects that match the given string of text | key: searchProjects

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Search string / Required searchString		Provide a string value to search on.	Search

Search Users

Returns a single user that matches the given string of text | key: searchUsers

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Connection connection / Required jiraConnection
Search string / Required searchString		Provide a string value to search on.	Search

Transition Issue

Transition an existing issue by Id | key: transitionIssue

Input	Default	Notes	Example
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection
Transition ID string / Required transitionId		Provide the ID of the Transition.	10201

Update Comment

Update the contents and metadata of an existing comment. | key: updateComment

Input	Default	Notes	Example
Comment string / Required comment		Provide a string value for the comment.	This is an example comment.
Comment ID string / Required commentId		Provide the Comment ID.	10201
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Connection connection / Required jiraConnection

Update Issue

Update an existing issue within a given project | key: updateIssue

Input	Default	Notes	Example
ADF Description code ADFdescription		The 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.
Assignee Account ID string assignee		Provide the Account ID for the person being assigned the issue.	b7b399c5b7c40279d7211271
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Provide a string value for the description of the issue.	This is an example summary.
Due Date string dueDate		Provide due date for the issue.	2019-05-11
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Fix Versions code fixVersions		Provide JSON data for the fix versions. Your object must have a property 'id'
Issue ID string / Required issueId		Provide the ID of the Issue.	10201
Issue Type Name string issueType		Provide a value for the name type of the issue. Use this field or the Issue Type ID field.	Task
Issue Type ID string issueTypeId		Provide the ID of the Issue Type. Use this field or the Issue Type Name field.	10001
Connection connection / Required jiraConnection
Labels string Value List labels		Provide a list of labels for the issue.	performance
Priority string priority		Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.	High
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Reporter Account ID string reporter		Provide the Account ID for the person that is reporting the issue.	b7b399c5b7c40279d7211271
Summary string summary		Provide a string value for the summary of the issue.	This is an example summary.
Versions code versions		Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.

Update Version

Update an existing version by Id | key: updateVersion

Input	Default	Notes	Example
Archived boolean archived	false	This flag determines if the given version is archived.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Provide a string value for the description of the issue.	This is an example summary.
Dynamic Fields code dynamicValues		A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values string Key Value List fieldValues		The names of the fields and their values to use when creating/updating a record	projectId=1000,name=Example
Connection connection / Required jiraConnection
Project ID string / Required projectId		Provide the ID or Name of the Project.	10201
Project Key string projectKey		Provide a string value for the key of the project.	JS-Example
Released boolean released	false	This flag determines if the given version has been released.
Release Date string releaseDate		Provide a valid date for the release of the given version.	2021-07-22
Start Date string startDate		Provide a value for the startDate.	2021-07-22
Version ID string / Required versionId		Provide the ID of the Version.	10201
Version Name string versionName		Provide a string value for the name of the version.	2019.08.18

Example Payload for Update Version

{
  "data": {
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
    "id": "10000",
    "description": "An excellent version",
    "name": "New Version 1",
    "archived": false,
    "released": true,
    "releaseDate": "2010-07-06",
    "userReleaseDate": "6/Jul/2010",
    "project": "PXA",
    "projectId": 10000
  }
}

Manage Jira issues, comments, projects and users

Description​

API Documentation​

Connections​

Jira Basic Connection​

Jira OAuth 2.0 Connection​

Data Sources​

Issue Fields​

Select Issue Type​

Select Issue Types​

Select Project​

Select Projects​

Actions​

Add Comment​

Add Issue Attachment​

Create Issue​

Create User​

Create Version​

Create Webhook​

Registering a Webhook Notes

Delete Comment​

Delete Issue​

Delete Webhook​

Download Issue Attachment​

Find Issue​

Find Project​

Find User​

Get Board​

Get Comments​

Get Current User​

Get Issue​

Get Project​

Get Status List​

Get User​

Get Version​

List Assignable Users​

List Board Sprints​

List Boards​

List Issue Custom Fields​

List Issue Fields​

List Issue Link Types​

List Issue Transitions​

List Issue Types​

List Issue Worklogs​

List Issues​

List Priorities​

List Projects​

List Versions​

List Webhooks​

Query​

Raw Request​

Refresh Webhook​

Search Issues​

Search Projects​

Search Users​

Transition Issue​

Update Comment​

Update Issue​

Update Version​