Jira Integration with Orkes Conductor
Available since
- v5.3.0 and later
Integrating Jira with Orkes Conductor lets you build workflows that interact with your Jira using the following operations:
- Create Issue
- Get Issue
- Update Issue
- Delete Issue
- Search Issues
- Get Transitions
- Transition Issue
- Get Issue Changelog
- Notify Issue
- Add Comment
- Get Comment
- Get Comments
- Update Comment
- Delete Comment
- Add Attachment
- Get Attachment
- Get Issue Attachments
- Remove Attachment
- List Projects
- Get Project
- Search Users
- Get Sprint
- Get Sprint Issues
- Get User
This guide explains how to set up and use the integration. Here’s an overview:
- Get the required credentials from Jira.
- Configure a new Jira integration in Orkes Conductor.
- Use Jira integration in workflows.
Step 1: Get the Jira credentials
To integrate Jira with Orkes Conductor, create an API token from your Atlassian account. If your Atlassian account uses a password or third-party login, you may receive a one-time verification code to your email before you can create or manage API tokens.
To get the API token:
- Sign in with your Atlassian account.
- Select Create API token.
- Enter a label for the token.
- Set an expiration date (1–365 days; default is 1 year).
- Select Create.
- Select Copy to clipboard and save the token, as it will not be shown again.
Step 2: Add an integration for Jira
After obtaining the credentials, add a Jira integration to your Conductor cluster.
To create an integration:
- Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
- Select + New integration.
- In the Project Management section, choose Jira.
- Select + Add and enter the following parameters:
| Parameter | Description | Required/Optional |
|---|---|---|
| Integration name | A name for the integration. | Required. |
| Base URL | The base URL of your Jira account. For example: https://your-domain.atlassian.net. | Required. |
| The email of your Atlassian account using which the API token is generated. | Required. | |
| API Key | The Atlassian API token generated in Step 1. | Required. |
| Description | A description of the integration. | Required. |
- (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
- Select Save.
Step 3: Use Jira integration in workflows
Once the integration is ready, this can be used directly within the workflows.
To use Jira integration in a workflow:
- Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
- Select + Define workflow.
- In your workflow, select the (+) icon and select Connected Apps.
- In Add Task panel on the right, search for Jira, and select the integration created in Step 2.
The following operations are available for use with this integration.
| Operation | Description |
|---|---|
| Create Issue | Creates a new issue in a Jira project. |
| Get Issue | Retrieves the details of a specific Jira issue by its ID or key. |
| Update Issue | Updates an existing Jira issue. |
| Delete Issue | Deletes an issue from Jira. |
| Search Issues | Searches for Jira issues using JQL (Jira Query Language). |
| Get Transitions | Retrieves the available transitions for a Jira issue. |
| Transition Issue | Transitions a Jira issue to a different status. |
| Get Issue Changelog | Retrieves the change history of a Jira issue. |
| Notify Issue | Sends an email notification for a Jira issue and adds it to the mail queue. |
| Add Comment | Adds a comment to a Jira issue. |
| Get Comment | Retrieves a specific comment from a Jira issue. |
| Get Comments | Retrieves all comments for a Jira issue. |
| Update Comment | Updates an existing comment on a Jira issue. |
| Delete Comment | Deletes a comment from a Jira issue. |
| Add Attachment | Adds an attachment to a Jira issue. |
| Get Issue Attachments | Retrieves all attachments for a Jira issue. |
| Get Attachment | Retrieves metadata for a Jira attachment by its ID. |
| Remove Attachment | Removes an attachment from Jira by its ID. |
| List Projects | Retrieves all Jira projects visible to the authenticated user. |
| Get Project | Retrieves the details of a specific Jira project. |
| Search Users | Searches for users in Jira. |
| Get Sprint | Retrieves the details of a Jira sprint by its ID |
| Get Sprint Issues | Retrieves all issues in a Jira sprint. |
| Get User | Retrieves the details of a Jira user by their account ID. |
- Select the required operation, configure the parameters, and select Save > Confirm.
- Select Execute to run the workflow.
For the complete operations parameters and output reference, see Jira Operations Reference.