Skip to main content

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.

Authorization Notes#

Basic Auth#

If you select Basic Auth, you will need to supply your Jira email and an API token to the credential. For information on generating an API token refer to the Atlassian docs

OAuth 2.0#

While Jira's Cloud API has support for legacy OAuth 1.0, Prismatic only supports OAuth 2.0 flows. If you select OAuth 2.0, you need to enable it for your app using the developer console. For more information, follow the guide here When you create your Jira app be sure to enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Consult Jira to determine the proper OAuth Scopes to assign to the credential. It is important to note the difference in the host URL when using OAuth 2.0. If you are using OAuth 2.0, you MUST format your url like the following: https://api.atlassian.com/ex/jira/{cloudId}/rest/api/2/project You can obtain a cloud id by sending an authenticated request to the following endpoint: https://api.atlassian.com/oauth/token/accessible-resources Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the values that you got from the Developer Console
  • For Scopes choose from the list found on the Atlassian Docs

Jira Connections#

Jira Basic Connection#

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Password

string
/ Required
passwordProvide a password to authenticate all requests with. Cloud users need to generate an API token for this value.exampleSecurePassword

Username

string
/ Required
usernameProvide a valid username for the given jira account you want to connect.exampleUser

Version

string
/ Required
versionProvide a string value for the version of your Jira API request2

Jira OAuth 2.0 Connection#

InputKeyDefaultNotesExample

Authorize URL

string
/ Required
Hidden Field
authorizeUrlhttps://auth.atlassian.com/authorize?audience=api.atlassian.comThe OAuth 2.0 Authorization URL for Jira

Client Id

string
/ Required
clientId

Client Secret

string
/ Required
clientSecret

Host

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Scopes

string
/ Required
scopesA space-delimited set of one or more scopes to get the user's permission to access.

Token URL

string
/ Required
Hidden Field
tokenUrlhttps://auth.atlassian.com/oauth/tokenThe OAuth 2.0 Token URL for Jira

Version

string
/ Required
versionProvide a string value for the version of your Jira API request2

Triggers#

Webhook#

Trigger for handling webhook requests from your Jira project | key: webhook

You can configure a Jira webhook to send information to a Prismatic webhook URL under certain conditions (a "Project" is created, an "Issue" is updated, etc.).

You can manage all of your Jira webhooks in the Atlassian Developer Console

Output Example Payload#

{  "payload": {    "headers": {      "accept": "*/*",      "Content-Type": "application/json; charset=UTF-8",      "Host": "hooks.example.prismatic.io",      "X-Atlassian-Webhook-Identifier": "3435193786597450860"    },    "body": {      "data": {        "timestamp": 98034890234,        "webhookEvent": "jira:issue_created",        "issue_event_type_name": "issue_created"      },      "contentType": "application/json; charset=UTF-8"    },    "rawBody": {      "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] }    },    "queryParameters": {      "user_id": "ExampleUserId",      "user_key": "ExampleUserKey"    },    "webhookUrls": {      "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="    },    "webhookApiKeys": { "Flow 1": ["abc-123"] },    "customer": {      "externalId": "customer-example-external-id",      "name": "John Doe"    }  }}

Actions#

Add Comment#

Add a comment to an existing issue | key: addComment

InputKeyNotesExample

Comment

string
/ Required
commentProvide a string value for the comment.10000

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Connection Input

connection
/ Required
jiraConnection

Create Issue#

Create an issue within a given project | key: createIssue

InputKeyNotesExample

Assignee Id

string
assigneeProvide an Id for the person being assigned the issue.6130f823036d9e006aba2525

Description

string
descriptionProvide a string value for the description of the issue.This is an example summary.

Issue Type

string
/ Required
issueTypeProvide a string value for the type issue you would like to make

Connection Input

connection
/ Required
jiraConnection

Project Id

string
/ Required
projectIdProvide a string value for the unique Id of the project10000

Reporter Id

string
reporterProvide an Id for the person that is reporting the issue6130f823036d9e006aba2525

Summary

string
/ Required
summaryProvide a string value for the summary of the issue.This is an example summary.

Delete Comment#

Delete a comment from an issue | key: deleteComment

InputKeyNotesExample

Comment Id

string
/ Required
commentIdProvide a number for the comment Id.1000

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Connection Input

connection
/ Required
jiraConnection

Delete Issue#

Delete an issue by id | key: deleteIssue

InputKeyNotesExample

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Connection Input

connection
/ Required
jiraConnection

Find Issue#

Get information and metadata about an issue by id | key: findIssue

InputKeyNotesExample

Issue Number

string
/ Required
issueNumberProvide a string value for the issue number.10000

Connection Input

connection
/ Required
jiraConnection

Find User#

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

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the unique Id of the account10000

Expand

string
expandThe response may contain a list under the _expandable property; you can specify any of its values separated by commas.body, version, history

Connection Input

connection
/ Required
jiraConnection

Get Comments#

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

InputKeyNotesExample

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Connection Input

connection
/ Required
jiraConnection

List Projects#

Retrieve a list of all projects | key: listProjects

InputKeyNotes

Connection Input

connection
/ Required
jiraConnection

Update Issue#

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

InputKeyNotesExample

Assignee Id

string
assigneeProvide an Id for the person being assigned the issue.6130f823036d9e006aba2525

Description

string
descriptionProvide a string value for the description of the issue.This is an example summary.

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Issue Type

string
/ Required
issueTypeProvide a string value for the type issue you would like to make

Connection Input

connection
/ Required
jiraConnection

Project Id

string
/ Required
projectIdProvide a string value for the unique Id of the project10000

Reporter Id

string
reporterProvide an Id for the person that is reporting the issue6130f823036d9e006aba2525

Summary

string
/ Required
summaryProvide a string value for the summary of the issue.This is an example summary.