Jira

Jira is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management.

Categories: project-management

Type: jira/v1

---

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
yourDomain	Your domain	STRING	e.g https://{yourDomain}}.atlassian.net	true
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

---

Actions

Create Issue

Name: createIssue

Creates a new issue.

Properties

Name	Label	Type	Description	Required
project	Project ID	STRING	ID of the project to create the issue in.	true
summary	Summary	STRING	A brief summary of the issue.	true
issuetype	Issue Type ID	STRING Depends On project	Id of the issue type.	true
parent	Parent Issue ID	STRING Depends On project	ID of the parent issue.	true
assignee	Assignee ID	STRING Depends On project	ID of the user who will be assigned to the issue.	false
priority	Priority ID	STRING	ID of the priority of the issue.	false
description	Description	STRING	Description of the issue.	false

Example JSON Structure

{
  "label" : "Create Issue",
  "name" : "createIssue",
  "parameters" : {
    "project" : "",
    "summary" : "",
    "issuetype" : "",
    "parent" : "",
    "assignee" : "",
    "priority" : "",
    "description" : ""
  },
  "type" : "jira/v1/createIssue"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the created issue or subtask.
key	STRING	The key of the created issue or subtask.
self	STRING	The URL of the created issue or subtask.

Output Example

{
  "id" : "",
  "key" : "",
  "self" : ""
}

Create Issue Comment

Name: createIssueComment

Adds a comment to an issue.

Properties

Name	Label	Type	Description	Required
project	Project ID	STRING	ID of the project where the issue is located.	true
issueId	Issue ID	STRING Depends On project	ID of the issue where the comment will be added.	true
comment	Comment	STRING	The text of the comment.	true

Example JSON Structure

{
  "label" : "Create Issue Comment",
  "name" : "createIssueComment",
  "parameters" : {
    "project" : "",
    "issueId" : "",
    "comment" : ""
  },
  "type" : "jira/v1/createIssueComment"
}

Output

Type: OBJECT

Properties

Name	Type	Description
self	STRING
id	STRING
author	OBJECT Properties {STRING(accountId), BOOLEAN(active), STRING(displayName), STRING(self)}
body	STRING
updateAuthor	OBJECT Properties {STRING(accountId), BOOLEAN(active), STRING(displayName), STRING(self)}
created	STRING
updated	STRING
visibility	OBJECT Properties {STRING(identifier), STRING(type), STRING(value)}

Output Example

{
  "self" : "",
  "id" : "",
  "author" : {
    "accountId" : "",
    "active" : false,
    "displayName" : "",
    "self" : ""
  },
  "body" : "",
  "updateAuthor" : {
    "accountId" : "",
    "active" : false,
    "displayName" : "",
    "self" : ""
  },
  "created" : "",
  "updated" : "",
  "visibility" : {
    "identifier" : "",
    "type" : "",
    "value" : ""
  }
}

Get Issue

Name: getIssue

Get issue details in selected project.

Properties

Name	Label	Type	Description	Required
project	Project ID	STRING	ID of the project where the issue is located.	true
issueId	Issue ID	STRING Depends On project		true

Example JSON Structure

{
  "label" : "Get Issue",
  "name" : "getIssue",
  "parameters" : {
    "project" : "",
    "issueId" : ""
  },
  "type" : "jira/v1/getIssue"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the issue.
key	STRING	The key of the issue.
self	STRING	The URL of the issue details.
fields	OBJECT Properties {{STRING(id), STRING(name)}(issuetype), {STRING(id), STRING(name)}(project), {STRING(id), STRING(name)}(priority), {STRING(accountId), STRING(displayName)}(assignee), STRING(summary)}

Output Example

{
  "id" : "",
  "key" : "",
  "self" : "",
  "fields" : {
    "issuetype" : {
      "id" : "",
      "name" : ""
    },
    "project" : {
      "id" : "",
      "name" : ""
    },
    "priority" : {
      "id" : "",
      "name" : ""
    },
    "assignee" : {
      "accountId" : "",
      "displayName" : ""
    },
    "summary" : ""
  }
}

Search Issues

Name: searchForIssuesUsingJql

Search for issues using JQL

Properties

Name	Label	Type	Description	Required
jql	JQL	STRING	The JQL that defines the search. If no JQL expression is provided, all issues are returned	false
maxResults	Max Results	INTEGER	The maximum number of items to return per page.	true

Example JSON Structure

{
  "label" : "Search Issues",
  "name" : "searchForIssuesUsingJql",
  "parameters" : {
    "jql" : "",
    "maxResults" : 1
  },
  "type" : "jira/v1/searchForIssuesUsingJql"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the issue.
key	STRING	The key of the issue.
self	STRING	The URL of the issue details.
fields	OBJECT Properties {{STRING(id), STRING(name)}(issuetype), {STRING(id), STRING(name)}(project), {STRING(id), STRING(name)}(priority), {STRING(accountId), STRING(displayName)}(assignee), STRING(summary)}

Output Example

[ {
  "id" : "",
  "key" : "",
  "self" : "",
  "fields" : {
    "issuetype" : {
      "id" : "",
      "name" : ""
    },
    "project" : {
      "id" : "",
      "name" : ""
    },
    "priority" : {
      "id" : "",
      "name" : ""
    },
    "assignee" : {
      "accountId" : "",
      "displayName" : ""
    },
    "summary" : ""
  }
} ]

Triggers

New Issue

Name: newIssue

Triggers when a new issue is created.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
project	Project ID	STRING	Id of the project where new issue is created.	true
issuetype	Issue Type ID	STRING Depends On project	ID of the issue type.	false

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the issue.
key	STRING	The key of the issue.
self	STRING	The URL of the issue details.
fields	OBJECT Properties {{STRING(id), STRING(name)}(issuetype), {STRING(id), STRING(name)}(project), {STRING(id), STRING(name)}(priority), {STRING(accountId), STRING(displayName)}(assignee), STRING(summary)}

JSON Example

{
  "label" : "New Issue",
  "name" : "newIssue",
  "parameters" : {
    "project" : "",
    "issuetype" : ""
  },
  "type" : "jira/v1/newIssue"
}

Updated Issue

Name: updatedIssue

Triggers when an issue is updated.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
project	Project ID	STRING	ID of the project where issues is updated.	true
issuetype	Issue Type ID	STRING Depends On project	ID of the issue type.	false

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the issue.
key	STRING	The key of the issue.
self	STRING	The URL of the issue details.
fields	OBJECT Properties {{STRING(id), STRING(name)}(issuetype), {STRING(id), STRING(name)}(project), {STRING(id), STRING(name)}(priority), {STRING(accountId), STRING(displayName)}(assignee), STRING(summary)}

JSON Example

{
  "label" : "Updated Issue",
  "name" : "updatedIssue",
  "parameters" : {
    "project" : "",
    "issuetype" : ""
  },
  "type" : "jira/v1/updatedIssue"
}

---

---

Additional instructions

---

CONNECTION