Jira Node

The Jira node connects workflows to the Jira REST API for project, issue, comment, attachment, user, notification, and transition automation.

The Jira node connects workflows to the Jira REST API for project, issue, comment, attachment, user, notification, and transition automation. The default operation is Search Issues.

Overview

PropertyValue
Inputs1
Outputs1
CredentialJira (Cloud email/API token or Data Center username/password, base URL, deployment mode, optional REST API version)
Output$nodeLabel.*

Credential

Create a Jira credential in the Credentials Tab. Stored config keys are email, api_token, base_url, deployment, and optional api_version. For Jira Cloud, email stores the Atlassian account email and api_token stores the Atlassian API token. For Jira Data Center / Server, those same keys store the Basic auth username and password. See Third-Party Integrations for setup steps.

FieldConfig keyDescription
Jira Email / UsernameemailJira Cloud Atlassian account email, or Jira Data Center / Server username
API Token / Passwordapi_tokenJira Cloud Atlassian API token, or Jira Data Center / Server password for Basic auth
Base URLbase_urlJira site URL, for example https://your-domain.atlassian.net
Deploymentdeploymentcloud for Jira Cloud or data_center for Jira Data Center / Server
REST API Versionapi_versionDefaults to 3 for Jira Cloud. Data Center / Server uses REST API v2

Data Center / Server personal access tokens and Bearer auth are not supported by the Jira credential yet.

Use Test Connection to verify the credential against the current Jira user.

Operations

OperationRequired fieldsOutput
Get Myselfuser
List ProjectsOptional Limit, Start Atprojects, count, pagination
Search IssuesOptional JQL, Issue Fields, Limit, Next Page Token, Start Atissues, count, pagination
Get IssueIssue Key or IDissue, key
Create IssueProject Key, Summaryissue, key
Update IssueIssue Key or ID and at least one changed fieldissue, key
Delete IssueIssue Key or IDdeleted
Get Issue ChangelogIssue Key or ID; optional Limit, Start Atchangelog, count, pagination
Notify IssueIssue Key or ID, Subject, Text Bodynotified
List CommentsIssue Key or ID; optional Limit, Start Atcomments, count, pagination
Create CommentIssue Key or ID, Comment Bodycomment
Get CommentIssue Key or ID, Comment IDcomment
Update CommentIssue Key or ID, Comment ID, Comment Bodycomment
Delete CommentIssue Key or ID, Comment IDdeleted
Add AttachmentIssue Key or ID, Filename, Base64 contentattachments, count
Get AttachmentAttachment ID; optional Include Binaryattachment
List AttachmentsIssue Key or ID; optional Limit, Start At, Include Binaryattachments, count, pagination
Delete AttachmentAttachment IDdeleted
List TransitionsIssue Key or IDtransitions, count
Transition IssueIssue Key or ID, Transition IDtransition, issue, key
Get UserAccount ID / Usernameuser
Create UserUser Emailuser
Delete UserAccount ID / Usernamedeleted

Expression-capable text fields support expressions such as $input.text. jiraIncludeBinary is a boolean toggle and does not support expressions, but it can be marked as agent-provided when the Jira node is attached to an Agent tool handle.

Issue and update fields

  • Project Key is the short project key such as ENG. Use List Projects to discover keys.
  • Issue Key or ID accepts keys such as ENG-123 or numeric issue IDs. Use Search Issues or List Projects to discover values.
  • Transition ID comes from List Transitions. Each transition object includes an id field.
  • Comment ID and Attachment ID come from List Comments, List Attachments, or prior create/get responses.
  • Account ID / Username is the Jira Cloud accountId value or the Jira Data Center / Server username. Get Myself or Get User can help you discover it.
  • Issue description and comment body text are sent as Atlassian Document Format on REST API v3; when the credential deployment is Data Center / Server, they are sent as plain text. In v3, newline characters become separate paragraphs.
  • Get Issue Changelog uses Jira Cloud's paginated changelog endpoint. For Data Center / Server, it reads expanded issue changelog data and applies the configured offset/limit to the returned histories.
  • On Update Issue, leave optional fields empty to preserve their current values.
  • Set Description or Assignee Account ID / Username to null on update to clear those fields. Labels cannot be cleared with null.
  • Recipients JSON on Notify Issue defaults to {"assignee":true} when omitted. Common keys include assignee, reporter, watchers, and voters (for example {"assignee":true,"watchers":true}).
  • Add Attachment accepts raw base64 or data URL content and is limited by the platform file size setting (default 99 MB).

Pagination

  • Search Issues uses cursor pagination via jiraNextPageToken for Jira Cloud. Read pagination.nextPageToken from the previous run and pass it into the next Search Issues node.
  • Search Issues uses offset pagination via jiraStartAt for Jira Data Center / Server. Read pagination.startAt, pagination.maxResults, and pagination.total to calculate the next page.
  • List Projects, Get Issue Changelog, List Comments, and List Attachments use offset pagination with jiraLimit and jiraStartAt. Paged results return pagination.startAt, pagination.maxResults, pagination.total, and pagination.isLast.
  • List Attachments fetches all attachments from the issue first, then slices the result client-side. Pagination fields still describe the returned page, but large issues may incur an extra fetch cost.
  • List Transitions does not paginate.

Key Fields

FieldUsed byNotes
credentialIdAll operationsOwned Jira credential UUID
jiraOperationAll operationsDefaults to searchIssues
jiraProjectKeyCreate IssueProject key such as ENG
jiraIssueKeyIssue, comment, attachment, notification, and transition operationsIssue key such as ENG-123 or numeric issue ID
jiraIssueTypeCreate IssueDefaults to Task
jiraIssueTypeIdCreate IssueOptional issue type ID; overrides jiraIssueType when set
jiraSummaryCreate/Update IssueRequired for Create Issue
jiraDescriptionCreate/Update IssueSent as ADF on REST API v3 or plain text on REST API v2; use null on update to clear description
jiraJqlSearch IssuesDefaults to updated >= -30d ORDER BY updated DESC
jiraFieldsSearch IssuesOptional JSON array or comma-separated issue fields; defaults to key, summary, status, assignee, and issuetype when empty
jiraAssigneeAccountIdCreate/Update IssueJira Cloud accountId or Data Center / Server username; use null on update to clear assignee
jiraLabelsCreate/Update IssueJSON array or comma-separated text
jiraCommentBodyCreate/Update CommentSent as ADF on REST API v3 or plain text on REST API v2
jiraCommentIdGet/Update/Delete CommentJira comment ID
jiraTransitionIdTransition IssueDiscover with List Transitions
jiraAttachmentIdGet/Delete AttachmentJira attachment ID
jiraAttachmentFilenameAdd AttachmentUploaded filename
jiraAttachmentBase64Add AttachmentRaw base64 or data URL content; subject to file size limit
jiraAttachmentMimeTypeAdd AttachmentOptional MIME type; inferred from filename when empty
jiraIncludeBinaryGet/List AttachmentBoolean toggle; adds content_base64 when enabled
jiraNotifySubjectNotify IssueRequired notification subject
jiraNotifyTextBodyNotify IssueRequired plain-text notification body
jiraNotifyHtmlBodyNotify IssueOptional HTML body
jiraNotifyToNotify IssueRecipients JSON; defaults to {"assignee":true}
jiraAccountIdGet/Delete UserJira Cloud accountId or Data Center / Server username
jiraUserEmailCreate UserNew user email address
jiraUsernameCreate UserOptional Data Center / Server username; falls back to jiraUserEmail
jiraUserDisplayNameCreate UserOptional display name
jiraUserProductsCreate UserJSON array or comma-separated product keys; Jira Cloud only
jiraLimitSearch Issues, List Projects, Get Issue Changelog, List Comments, List AttachmentsDefaults to 50; range 1–100
jiraStartAtSearch Issues on Data Center / Server, List Projects, Get Issue Changelog, List Comments, List AttachmentsOffset pagination start index
jiraNextPageTokenSearch Issues on Jira CloudCursor token from a previous search response

Examples

Create an issue from upstream input:

  • Operation: createIssue
  • Project Key: ENG
  • Issue Type: Task
  • Summary: $input.title
  • Description: $input.description
  • Labels: ["automation"]

Update an issue and clear the assignee:

  • Operation: updateIssue
  • Issue Key or ID: ENG-123
  • Summary: $input.title
  • Assignee Account ID / Username: null

Search issues with custom fields and cursor pagination:

  • Operation: searchIssues
  • JQL: project = ENG AND updated >= -30d ORDER BY updated DESC
  • Issue Fields: ["key","summary","status"]
  • Limit: 25
  • Next Page Token: $searchJira.pagination.nextPageToken

Search issues on Data Center with offset pagination:

  • Operation: searchIssues
  • JQL: project = ENG ORDER BY updated DESC
  • Limit: 25
  • Start At: 25

Transition an issue after listing available transitions:

  • Operation: listTransitions
  • Issue Key or ID: ENG-123
  • Then run Transition Issue with Transition ID: $listTransitions.transitions[0].id

Notify watchers about an issue update:

  • Operation: notifyIssue
  • Issue Key or ID: ENG-123
  • Subject: Issue updated
  • Text Body: $input.text
  • Recipients JSON: {"assignee":true,"watchers":true}

Output

Every successful operation sets:

  • $jira.success
  • $jira.operation

Get Myself exposes user.

Paginated list operations expose count, a collection field, and pagination:

OperationCollection keyPagination shape
List Projectsprojects{ startAt, maxResults, total, isLast }
Search IssuesissuesCloud: { maxResults, nextPageToken, isLast }; Data Center: { startAt, maxResults, total, isLast }
Get Issue Changelogchangelog{ startAt, maxResults, total, isLast }
List Commentscomments{ startAt, maxResults, total, isLast }
List Attachmentsattachments{ startAt, maxResults, total, isLast }

List Transitions exposes transitions and count without pagination.

Issue mutations and reads expose the Jira issue payload plus key where applicable.

Comment get/create/update expose comment; delete exposes deleted.

Transition Issue exposes transition as { transitionId }, plus the refreshed issue and key.

Attachment add exposes attachments and count. Get Attachment exposes attachment; List Attachments exposes attachments, count, and pagination. When Include Binary is enabled, each attachment object may include content_base64. Delete exposes deleted.

User get/create expose user; delete exposes deleted.

Notify Issue exposes notified.

Common access patterns:

  • $searchJira.issues[0].key
  • $searchJira.pagination.nextPageToken
  • $createJiraIssue.key
  • $listTransitions.transitions[0].id
  • $getAttachment.attachment.content_base64