Jira Cloud

Create and search issues, add comments, and manage projects in Jira.

Project managementOAuth16 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (16)
create_issue
search_issues
update_issue
add_issue_attachment
add_issue_comment
add-watcher-to-issue
assign_issue
custom_api_call
delete_issue_comment
find-user
get_issue
get-issue-attachment
link-issues
list_issue_comments
markdownToJiraFormat
update_issue_comment
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: read:jira-workwrite:jira-work

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("jira_cloud", "create_issue", {
    "projectId": "<projectId>",
    "issueTypeId": "<issueTypeId>",
    "issueFields": {}
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Jira Cloud answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "jira-cloud-create-issue",
  name: "Jira Cloud: Create Issue",
  description: "Calls Jira Cloud when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("jira_cloud", {
      "action": "create_issue",
      "projectId": "<projectId>",
      "issueTypeId": "<issueTypeId>",
      "issueFields": {}
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/jira_cloud/create_issue" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"projectId":"<projectId>","issueTypeId":"<issueTypeId>","issueFields":{}}}'

Actions

create_issuein catalog

Create Issue. Creates a new issue in a project.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueTypeId`required	id (picked from your account)	Issue Type
`issueFields`required	object (depends on other props)	Fields
`adfFields`optional	ids (picked from your account)	https://developer.atlassian.com/cloud/jira/platform/apis/document/structure

search_issuesin catalog

Search Issues. Search for issues with JQL

Input	Type	Description
`jql`required	long text	The JQL query to use in the search
`maxResults`required	number	Max Results
`sanitizeJql`required	boolean	Sanitize JQL

update_issuein catalog

Update Issue. Updates an existing issue.

Input	Type	Description
`issueId`required	id (picked from your account)	Issue ID or Key
`statusId`optional	id (picked from your account)	Status
`issueFields`required	object (depends on other props)	Fields
`adfFields`optional	ids (picked from your account)	https://developer.atlassian.com/cloud/jira/platform/apis/document/structure

add_issue_attachment

Add Attachment to Issue. Adds an attachment to an issue.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`attachment`required	file	Attachment

add_issue_comment

Add Issue Comment. Adds a comment to an issue.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`comment`required	long text	Comment Body
`isADF`optional	boolean	https://developer.atlassian.com/cloud/jira/platform/apis/document/structure

add-watcher-to-issue

Add Watcher to Issue. Adds a new watcher to an issue.

Input	Type	Description
`issueId`required	id (picked from your account)	Issue ID or Key
`userId`required	id (picked from your account)	User

assign_issue

Assign Issue. Assigns an issue to a user.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`assignee`required	id (picked from your account)	Assignee

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

delete_issue_comment

Delete Issue Comment. Deletes a comment on a specific issue.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`commentId`required	id (picked from your account)	Comment ID

find-user

Find User. Finds an existing user.

Input	Type	Description
`keyword`required	text	Keyword

get_issue

Get Issue. Get issue data.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`expand`optional	list of	Include additional information about the issue in the response
`mapNames`required	boolean	Map human readable names to Fields, Rendered Fields, Schema and Edit Meta. Notes: - This would implicitly add "names" to the expand field - If there are fields with the same name, they may be overrid…
`mapTransitions`required	boolean	Map human readable names to Transitions. Notes: - If there are transitions with the same name, they may be overridden - This changes the original data structure from list to map

get-issue-attachment

Get Issue Attachment. Retrieves an attachment from an issue.

Input	Type	Description
`attachmentId`required	text	Attachment ID

link-issues

Link Issues. Creates a link between two issues.

Input	Type	Description
`firstIssueId`required	id (picked from your account)	First Issue
`issueLinkTypeId`required	id (picked from your account)	Link Type
`secondIssueId`required	id (picked from your account)	Second Issue

list_issue_comments

List Issue Comments. Returns all comments for an issue.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`orderBy`required	one of "-created" \| "+created"	Order By
`limit`required	number	Maximum number of results

markdownToJiraFormat

Markdown to Jira format. Convert Markdown-formatted text to Jira's ADF syntax for use in comments and descriptions etc

Input	Type	Description
`markdown`required	long text	Markdown text

update_issue_comment

Update Issue Comment. Updates a comment to a specific issue.

Input	Type	Description
`projectId`required	id (picked from your account)	Project ID or Key
`issueId`required	id (picked from your account)	Issue ID or Key
`commentId`required	id (picked from your account)	Comment ID
`comment`required	long text	Comment Body
`isADF`optional	boolean	https://developer.atlassian.com/cloud/jira/platform/apis/document/structure

Details

Id: jira_cloud
Category: Project management
Tags: issues, project-management, agile, atlassian
Package: @activepieces/piece-jira-cloud@0.2.6
Tier: Built in