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.

Jira 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	Notes	Example
Input Host string / Required	Notes Provide a string value for the URL of your Jira account.	Example example.atlassian.net
Input API Key/Password string / Required	Notes Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value.	Example exampleSecurePassword
Input Username string / Required	Notes Provide a valid username for the given jira account you want to connect.	Example exampleUser
Input Version string / Required	Notes Provide a string value for the version of your Jira API request	Example 2

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). There you will be prompted to enter your redirect URL, which you can find under the credentials tab in the Prismatic settings. - https://oauth2.prismatic.io/callback - as a Redirect 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: 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 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, you can configure an OAuth 2.0 connection within Prismatic. Add a Jira step to your integration. 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: read:project:jiraread:user:jirawrite:issue:jiraread:issue:jiraread:issue-link:jirawrite:issue-link:jiraread:issue-link-type:jirawrite:issue-link-type:jiraread:issue.transition:jiradelete: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).

Jira API: manage:jira-configuration, manage:jira-project, write:jira-work, read:jira-work.

Input	Default	Notes	Example
Input Authorize URL string / Required	Default https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent	Notes The OAuth 2.0 Authorization URL for Jira	Example
Input Client ID string / Required	Default	Notes	Example c9e4APadFFkbtTycoNtrHKBtYgUyZWy
Input Client Secret password / Required	Default	Notes	Example ntDBx4ao5czkFu7Mzp5FTlYG0y3_ukxkSiPhwnTkhsdKHJITGRCGP3ZWlXTYyu
Input Scopes string / Required	Default 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	Notes A space-delimited set of one or more scopes to get the user's permission to access.	Example
Input Token URL string / Required	Default https://auth.atlassian.com/oauth/token	Notes The OAuth 2.0 Token URL for Jira	Example
Input Version string / Required	Default 2	Notes Provide a string value for the version of your Jira API request	Example 2

Data Sources

Issue Fields

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

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

---

Select Issue Type

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

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

---

Select Issue Types

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

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

---

Select Project

Select a project | key: selectProject | type: picklist

Input	Notes
Input Connection connection / Required	Notes

---

Select Projects

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

Input	Notes
Input Connection connection / Required	Notes

---

Actions

Add Comment

Add a comment to an existing issue | key: addComment

Input	Notes	Example
Input Comment string / Required	Notes Provide a string value for the comment.	Example This is an example comment.
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Create Issue

Create an issue within a given project | key: createIssue

Input	Notes	Example
Input Assignee Account ID string / Required	Notes Provide the Account ID for the person being assigned the issue.	Example b7b399c5b7c40279d7211271
Input Description string	Notes Provide a string value for the description of the issue.	Example This is an example summary.
Input Due Date string	Notes Provide due date for the issue.	Example 2019-05-11
Input Fix Versions code	Notes Provide JSON data for the fix versions. Your object must have a property 'id'	Example { id: "10001",}
Input Issue Type string / Required	Notes Provide a string value for the type of issue.	Example
Input Connection connection / Required	Notes	Example
Input Labels string Value List	Notes Provide a list of labels for the issue.	Example performance
Input Priority string	Notes Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.	Example High
Input Project ID string / Required	Notes Provide the ID of the Project.	Example 10201
Input Reporter Account ID string	Notes Provide the Account ID for the person that is reporting the issue.	Example b7b399c5b7c40279d7211271
Input Summary string / Required	Notes Provide a string value for the summary of the issue.	Example This is an example summary.
Input Versions code	Notes Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.	Example [ { "id": "10000" }]

---

Create User

Create a new user record | key: createUser

Input	Default	Notes	Example
Input Display Name string	Default	Notes Provide a string value for the display name to assign to the new user.	Example John Doe
Input Email Address string / Required	Default	Notes Provide a string value for a valid email address.	Example someone@example.com
Input Connection connection / Required	Default	Notes	Example
Input Notifications boolean / Required	Default false	Notes This flag will determine if the user will receive notifications.	Example
Input Password string / Required	Default	Notes Provide a password to assign to the user.	Example superSecretPassword
Input Username string / Required	Default	Notes Provide a string value for the username of the user.	Example Example User

---

Create Version

Create a new version | key: createVersion

Input	Default	Notes	Example
Input Archived boolean	Default false	Notes This flag determines if the given version is archived.	Example
Input Description string	Default	Notes Provide a string value for the description of the issue.	Example This is an example summary.
Input Connection connection / Required	Default	Notes	Example
Input Project ID string / Required	Default	Notes Provide the ID of the Project.	Example 10201
Input Project Key string	Default	Notes Provide a string value for the key of the project.	Example JS-Example
Input Released boolean	Default false	Notes This flag determines if the given version has been released.	Example
Input Release Date string	Default	Notes Provide a valid date for the release of the given version.	Example 2021-07-22
Input Start Date string	Default	Notes Provide a value for the startDate.	Example 2021-07-22
Input Version Name string / Required	Default	Notes Provide a string value for the name of the version.	Example 2019.08.18

Output Example Payload

{  "data": {    "id": "1000",    "description": "Example Description",    "name": "exampleVersion",    "archived": false,    "released": true,    "projectId": 10000  }}

---

Create Webhook

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

Input	Notes
Input Connection connection / Required	Notes
Input Webhook Details data / Required	Notes Webhook Details payload to send in this create request; 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
Input Webhook URL string / Required	Notes 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.

Output Example Payload

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

---

Delete Comment

Delete a comment from an issue | key: deleteComment

Input	Notes	Example
Input Comment ID string / Required	Notes Provide the Comment ID.	Example 10201
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Delete Issue

Delete an issue by id | key: deleteIssue

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

Input	Notes
Input Connection connection / Required	Notes
Input Webhook ID string / Required	Notes THe ID of the webhook to remove

Output Example Payload

{  "data": ""}

---

Download Issue Attachment

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

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Find Issue

Find Issue by attribute | key: findIssue

Input	Notes
Input Connection connection / Required	Notes
Input Search Type string / Required	Notes Attribute to search
Input Search Value string / Required	Notes Value to search for

---

Find Project

Find Project by attribute | key: findProject

Input	Notes
Input Connection connection / Required	Notes
Input Search Type string / Required	Notes Attribute to search
Input Search Value string / Required	Notes Value to search for

---

Find User

Find User by attribute | key: findUser

Input	Notes
Input Connection connection / Required	Notes
Input Search Value string / Required	Notes Value to search for

---

Get Board

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

Input	Notes	Example
Input Board ID string / Required	Notes Provide the ID of the Board.	Example 10201
Input Connection connection / Required	Notes	Example

---

Get Comments

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

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Get Current User

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

Input	Notes
Input Connection connection / Required	Notes

---

Get Issue

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

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Get Project

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

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project ID string / Required	Notes Provide the ID of the Project.	Example 10201

---

Get Status List

Returns a status list | key: getStatusList

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Get User

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

Input	Notes	Example
Input Account ID string / Required	Notes Provide the Account ID of the account to use.	Example b7b399c5b7c40279d7211271
Input Expand string	Notes The response may contain a list under the _expandable property; you can specify any of its values separated by commas.	Example body, version, history
Input Connection connection / Required	Notes	Example

---

Get Version

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

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

---

List Assignable Users

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

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Max Results string	Default 100	Notes Provide a value for the maximum amount of results to be returned in the request.	Example 100
Input Project Key string / Required	Default	Notes Provide a string value for the key of the project.	Example JS-Example
Input Start At string	Default 0	Notes Provide the index of the first item to return (to start from)	Example 3

Output Example Payload

{  "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
Input Board ID string / Required	Default	Notes Provide the ID of the Board.	Example 10201
Input Connection connection / Required	Default	Notes	Example
Input Max Results string	Default 100	Notes Provide a value for the maximum amount of results to be returned in the request.	Example 100
Input Start At string	Default 0	Notes Provide the index of the first item to return (to start from)	Example 3

---

List Boards

Retrieve a list of existing boards | key: listBoards

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Max Results string	Default 100	Notes Provide a value for the maximum amount of results to be returned in the request.	Example 100
Input Start At string	Default 0	Notes Provide the index of the first item to return (to start from)	Example 3

---

List Issue Custom Fields

List all configured issue fields | key: listIssueCustomFields

Input	Notes
Input Connection connection / Required	Notes

Output Example Payload

{  "data": [    {      "clauseNames": [],      "custom": false,      "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	Notes
Input Connection connection / Required	Notes

Output Example Payload

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

---

List Issue Link Types

List all available issue link types | key: listIssueLinkTypes

Input	Notes
Input Connection connection / Required	Notes

---

List Issue Transitions

Returns a list of issue transitions | key: listIssueTransitions

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

List Issue Types

Returns a list of issue types | key: listIssueTypes

Input	Notes
Input Connection connection / Required	Notes

---

List Issue Worklogs

Returns a list of issue worklogs | key: listIssueWorklogs

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

List Issues

Returns a list of issues | key: listIssues

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Max Results string	Default 100	Notes Provide a value for the maximum amount of results to be returned in the request.	Example 100
Input Start At string	Default 0	Notes Provide the index of the first item to return (to start from)	Example 3

---

List Priorities

Returns a list of all priorities | key: listPriorities

Input	Notes
Input Connection connection / Required	Notes

---

List Projects

Retrieve a list of all projects | key: listProjects

Input	Notes
Input Connection connection / Required	Notes

---

List Versions

Returns a list of all versions | key: listVersions

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project ID string / Required	Notes Provide the ID of the Project.	Example 10201

Output Example Payload

{  "data": [    {      "id": "1000",      "name": "exampleVersion",      "archived": false,      "released": false,      "projectId": 1000    },    {      "id": "1001",      "name": "exampleVersion2",      "archived": false,      "released": false,      "projectId": 1000    }  ]}

---

List Webhooks

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

Input	Notes
Input Connection connection / Required	Notes

Output Example Payload

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

---

Raw Request

Issue a raw HTTP request with the configured connection | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Data string	Default	Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input Form Data string Key Value List	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string	Default	Notes	Example
Input Query Parameter string Key Value List	Default	Notes 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.	Example
Input Response Type string	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example binary
Input Retry Delay (ms) string	Default 0	Notes The delay in milliseconds between retries.	Example
Input Retry On All Errors boolean	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Timeout string	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required	Default	Notes This is the URL to call.	Example /sobjects/Account
Input Use Exponential Backoff boolean	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

Refresh Webhook

Refresh webhook expiration by ID | key: refreshWebhook

Input	Notes
Input Connection connection / Required	Notes
Input Webhook ID string / Required	Notes THe ID of the webhook to remove

Output Example Payload

{  "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	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project Key string	Notes Provide a string value for the key of the project.	Example JS-Example
Input Search string / Required	Notes Provide a string value to search on.	Example Search

---

Search Projects

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

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Search string / Required	Notes Provide a string value to search on.	Example Search

---

Search Users

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

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Search string / Required	Notes Provide a string value to search on.	Example Search

---

Transition Issue

Transition an existing issue by Id | key: transitionIssue

Input	Notes	Example
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example
Input Transition ID string / Required	Notes Provide the ID of the Transition.	Example 10201

---

Update Comment

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

Input	Notes	Example
Input Comment string / Required	Notes Provide a string value for the comment.	Example This is an example comment.
Input Comment ID string / Required	Notes Provide the Comment ID.	Example 10201
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Connection connection / Required	Notes	Example

---

Update Issue

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

Input	Notes	Example
Input Assignee Account ID string	Notes Provide the Account ID for the person being assigned the issue.	Example b7b399c5b7c40279d7211271
Input Description string	Notes Provide a string value for the description of the issue.	Example This is an example summary.
Input Due Date string	Notes Provide due date for the issue.	Example 2019-05-11
Input Fix Versions code	Notes Provide JSON data for the fix versions. Your object must have a property 'id'	Example { id: "10001",}
Input Issue ID string / Required	Notes Provide the ID of the Issue.	Example 10201
Input Issue Type string	Notes Provide a string value for the type of issue.	Example
Input Connection connection / Required	Notes	Example
Input Labels string Value List	Notes Provide a list of labels for the issue.	Example performance
Input Priority string	Notes Provide the unique identifier of the priority. This value can either be an Id, key, or name of the desired record.	Example High
Input Project ID string / Required	Notes Provide the ID of the Project.	Example 10201
Input Reporter Account ID string	Notes Provide the Account ID for the person that is reporting the issue.	Example b7b399c5b7c40279d7211271
Input Summary string	Notes Provide a string value for the summary of the issue.	Example This is an example summary.
Input Versions code	Notes Provide JSON data for the versions. You must supply a JSON array with an object containing an Id.	Example [ { "id": "10000" }]

---

Update Version

Update an existing version by Id | key: updateVersion

Input	Default	Notes	Example
Input Archived boolean	Default false	Notes This flag determines if the given version is archived.	Example
Input Description string	Default	Notes Provide a string value for the description of the issue.	Example This is an example summary.
Input Connection connection / Required	Default	Notes	Example
Input Project ID string / Required	Default	Notes Provide the ID of the Project.	Example 10201
Input Project Key string	Default	Notes Provide a string value for the key of the project.	Example JS-Example
Input Released boolean	Default false	Notes This flag determines if the given version has been released.	Example
Input Release Date string	Default	Notes Provide a valid date for the release of the given version.	Example 2021-07-22
Input Start Date string	Default	Notes Provide a value for the startDate.	Example 2021-07-22
Input Version ID string / Required	Default	Notes Provide the ID of the Version.	Example 10201
Input Version Name string	Default	Notes Provide a string value for the name of the version.	Example 2019.08.18

Output Example Payload

{  "data": {    "id": "1000",    "description": "Example Description",    "name": "exampleVersion",    "archived": false,    "released": true,    "projectId": 10000  }}

---