Jira

Let’s learn how to connect Engini to Jira. This integration connects Engini workflows with Jira Cloud, allowing you to create and update issues, comments, components and versions, and to start workflows when issues change. To get started, create an account at Jira.

​

Add a Connection to Jira in Engini

​

Prerequisites

• A Jira Cloud site, for example your-company.atlassian.net.
• The email address of your Atlassian account.
• An API token from your Atlassian account. Note: The connection acts as the Atlassian user who created the API token. Your workflows can only do what that user is allowed to do in Jira.

​

Retrieve your Jira API Token

1. Sign in to your Atlassian account and open API tokens.
2. Click Create API token.
3. Enter a name for the token and click Create.
4. Click Copy and keep the token somewhere safe. Atlassian shows it only once.

​

Connecting Engini to Jira

1. Enter your Engini account at https://app.engini.io.
2. Navigate to the Connections page by clicking on Connections in the left sidebar or by clicking here.
3. Click on the “New Integration” option located at the top bar.
4. Choose the Jira option from the available applications.
5. Enter the following details in the “New Integration” form and press Save: 1. Connection Name - Enter a name that helps identify the Jira connection. 2. Url - Enter the address of your Jira Cloud site, for example https://your-company.atlassian.net. 3. Email - Enter the email address of your Atlassian account. 4. API Token - Enter the API token you created in the previous section. 5. Save - Click Save to create the connection.

​

Triggers

​

Issue Created Or Updated

Starts the workflow when an issue is created or updated in Jira. The trigger works through a Jira webhook that sends the event to Engini.

• URL - The webhook address of this trigger. Copy it and add it in Jira, as described below.

To send Jira events to this trigger:

1. In Jira, go to Settings > System > WebHooks.
2. Click Create a WebHook.
3. Paste the URL, choose the issue events you want to send (for example created and updated), and save the webhook.

Note: Creating a webhook in Jira requires Jira administrator permissions.

​

Check for Updated Issues

Starts the workflow when issues have been updated in Jira. Instead of waiting for Jira to send an event, the trigger checks Jira on a schedule and returns the issues that were updated in the last 15 minutes. Because it does not use a webhook, it does not require Jira administrator permissions.

1. Starting (UTC) - The date and time the schedule begins.
2. Recur every - How often the trigger checks Jira. Set this to 15 minutes so that no updates are missed.
3. Add time frame - Optionally limit the hours or days in which the trigger runs.

Each run returns the issues updated in the last 15 minutes, with their full issue details.

​

Actions

Most Jira actions work on an issue or on a project. You usually start by selecting the Issue or Project, and the other fields build on it.

​

Add Comment

Adds a comment to a Jira issue.

1. Issue - The issue to comment on. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Comment - The text of the comment, in plain text, for example “The customer confirmed the fix.” You can also map text from a previous step.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Expand and Visibility (restricts who can see the comment to a role or group, for example the “Administrators” role).

​

Assign Issue

Assigns a Jira issue to a user.

1. Issue - The issue to assign. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. User - The user who will become the assignee. Select the user from the list, map an account Id from a previous step such as Get All Users, or enter the Jira account Id.

​

Create Component

Creates a new component in a Jira project.

1. Name - The name of the new component, for example “Backend”. It must be unique in the project.
2. Project - The project that will hold the component. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Assignee Type (who issues of this component are assigned to by default, for example PROJECT_LEAD or UNASSIGNED), Description and Lead Account Id (the account Id of the component lead).

​

Create Custom Field Options (Context)

Adds new options to a custom field in a field context.

1. Custom Field - The custom field that gets the new options. Select it from the list, or enter its Id, for example “customfield_10000”.
2. Context - The field context that holds the options. Select the custom field first and then choose the context, or enter the context Id.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds Options: for each option you want to create, enter its Value. Note: Your Jira user needs Jira administrator rights to create custom field options.

​

Create Issue

Creates a new issue in a Jira project.

1. Project - The project that will hold the new issue. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”.
2. Issue Type - The type of the new issue, such as Task, Bug or Story. Select the project first, then choose the type from the list, or enter the issue type Id.
3. Summary - The title of the new issue, as it appears in Jira lists and boards, for example “Login page returns an error”.
4. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Add to Recent Projects, Description, Project Id (use the project key or the project Id, not both), Issue Type Name, Assignee, Priority Id, Priority Name, Labels, Due Date and Parent Issue Key (the key of the parent issue, for example “PROJ-100”, when you create a sub-task).

​

Create Issue Link

Links two Jira issues to each other.

1. Link Type - The relationship between the two issues. Enter its name exactly as written: Blocks, Cloners, Duplicate or Relates.
2. Inward Issue - The issue on the inward side of the link, for example “PROJ-124”. Select the issue or enter its key.
3. Outward Issue - The issue on the outward side of the link, for example “PROJ-123”. Select the issue or enter its key.
4. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Comment (a comment that is added to the issue together with the link).

​

Create Version

Creates a new version (release) in a Jira project.

1. Version Name - The name of the new version, for example “v2.1”. It must be unique in the project.
2. Project - The project that will hold the version. Select the project from the list, map it from a previous step, or enter its project Id, for example “10000”.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Archived, Description, Expand, Move Unfixed Issues To (the self link of the target version), Release Date and Start Date (ISO 8601, for example 2027-12-31), and Released.

​

Delete Attachment

Deletes an attachment from a Jira issue.

• Attachment Id - The Id of the attachment to delete, for example “10001”. You can get it from the Get Issue action, in the attachments of the issue.

​

Delete Comment

Deletes a comment from a Jira issue.

1. Issue - The issue that holds the comment. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Comment - The comment to delete. Select the issue first and then choose the comment from the list, or map the comment Id returned by Get Comments.

​

Delete Component

Deletes a component from a Jira project.

1. Project - The project that holds the component. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. Select it first to load its components.
2. Component - The component to delete. Choose it from the list, or map the component Id returned by Get Project Components.

​

Delete Issue

Deletes a Jira issue.

• Issue - The issue to delete. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.

Note: Deleting an issue can’t be undone. To close an issue instead, use the Transition Issue action.

​

Delete Issue Link

Removes a link between two Jira issues.

• Link Id - The Id of the issue link to remove, for example “10000”. You can get it from the Get Issue action, in the issue links of the issue.

​

Delete Version

Deletes a version (release) from a Jira project.

1. Version - The Id of the version to delete, for example “10000”. You can get it from the Get Project Versions action.
2. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Fix Version and Affected Version, each the Id of a version that replaces this one in the issues.

​

Delete Watcher

Removes a user from the watchers of a Jira issue.

1. Issue - The issue to remove the watcher from. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. User - The watcher to remove. Select the user from the list, map an account Id from a previous step such as Get Issue Watchers, or enter the Jira account Id.

​

Edit Issue

Updates the fields of an existing Jira issue.

1. Issue - The issue to edit. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field lets you choose which fields to change, so only the fields you add are updated. It adds these optional fields: Notify Users, Override Screen Security and Override Editable Flag (both need Jira admin permissions), Return Updated Issue, Expand (used with Return Updated Issue), Summary, Description, Issue Type Name, Assignee Account Id, Priority Id, Priority Name, Labels (replace all existing labels), Due Date (yyyy-MM-dd), Parent Issue Key and Issue Type.

​

Get All Users

Retrieves the users of your Jira site.

1. Top N - The maximum number of users Engini will return (default = 50). Increase it if your Jira site has more users.
2. Add Filter - Narrow the returned list with conditions. To learn more, click here. For example, return only the users whose display name contains “John”.

​

Get Attachment Content

Downloads the content of a file attached to a Jira issue.

1. Issue - The issue that holds the attachment. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Attachment - The file to download. After you select the issue, the Attachment field appears; choose the file from its list.

​

Get Changelogs

Retrieves the change history of a Jira issue.

1. Issue - The issue whose history you want. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Top N - The maximum number of change records Engini will return (default = 100). Each record shows who changed the issue, when, and which fields changed.

​

Get Comment

Retrieves a single comment from a Jira issue.

1. Issue - The issue that holds the comment. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Comment - The comment to retrieve. Select the issue first and then choose the comment from the list, or map the comment Id returned by a previous step, such as Get Comments or Add Comment.

​

Get Comments

Retrieves the comments of a Jira issue.

1. Issue - The issue whose comments you want. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Order - Optional. Enter created (oldest first, the default) to read the conversation from the beginning, or -created (newest first) to get the latest comments at the top.
3. Top N - The maximum number of comments Engini will return (default = 100). Enter a smaller number, for example 10, to get only a few comments.

​

Get Current User

Retrieves the Jira user the connection is signed in as, for example to get your own account Id.

​

Get Custom Field Contexts

Retrieves the contexts of a custom field. A context defines the projects and issue types where the field and its options apply.

1. Custom Field - The custom field whose contexts you want. Select it from the list, map it from a previous step such as Get Custom Fields, or enter its Id, for example “customfield_10000”.
2. Top N - The maximum number of contexts Engini will return (default = 50).

Note: Your Jira user needs Jira administrator rights, or permission to edit the workflow, to read field contexts.

​

Get Custom Fields

Retrieves the custom fields of your Jira site, such as their names and Ids.

1. Order - Optional. Enter how to sort the list: name (Name A-Z), -name (Name Z-A), lastUsed (last used oldest first) or -lastUsed (last used newest first). Leave it empty for Jira’s default order.
2. Top N - The maximum number of custom fields Engini will return (default = 50).

​

Get Issue

Retrieves the details of a Jira issue, such as its summary, status, assignee and fields.

• Issue - The issue to retrieve. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira. The action returns the summary, status, assignee, description and the other fields of the issue.

​

Get Issue Types for Project

Retrieves the issue types that are available in a Jira project, such as Task, Bug and Story.

• Project - The project whose issue types you want. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. The project key is the short prefix of your issue keys.

​

Get Issue Watchers

Retrieves the users who are watching a Jira issue.

• Issue - The issue whose watchers you want. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.

​

Get Project Components

Retrieves the components of a Jira project.

1. Project - The project whose components you want. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. The project key is the short prefix of your issue keys.
2. Top N - The maximum number of components Engini will return (default = 50).
3. Add Filter - Narrow the returned list with conditions. To learn more, click here. For example, return only the components whose name contains “Backend”.

​

Get Project Versions

Retrieves the versions (releases) of a Jira project.

1. Project - The project whose versions you want. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. The project key is the short prefix of your issue keys.
2. Top N - The maximum number of versions Engini will return (default = 50).
3. Add Filter - Narrow the returned list with conditions. To learn more, click here. For example, return only the versions that are not released yet.

​

Get Projects Paginated

Retrieves the projects of your Jira site.

1. Top N - The maximum number of projects Engini will return (default = 50). Increase it if your Jira site has more projects.
2. Add Filter - Narrow the returned list with conditions. To learn more, click here. For example, return only the projects whose name contains “Marketing”.

​

Get Transitions

Retrieves the transitions that can be applied to a Jira issue, such as moving it to another status.

1. Issue - The issue whose transitions you want. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira. The available transitions depend on the current status of the issue.
2. Add Filter - Narrow the returned list with conditions. To learn more, click here. For example, return only the transition named “In Progress”.

Add Filter also offers these optional settings: Expand (extra details to include in the response), Transition Id (return only the transition with this Id), Include Unavailable (true or false; set it to true to also return transitions whose conditions the issue does not currently meet, instead of only the available ones) and Sort Like Workflow (true or false; set it to true to return the transitions in the same order as the buttons on the Jira workflow bar, instead of Jira’s default order). Use the returned transition Id in a later Transition Issue step.

​

Get User

Retrieves the details of a single Jira user.

1. User - The user to retrieve. Select the user from the list, map an account Id from a previous step such as Get All Users, or enter the Jira account Id. The account Id is part of the address of the user’s Jira profile page.
2. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Expand (for example groups or applicationRoles, to return the user’s groups or application roles together with the user).

​

Transition Issue

Moves a Jira issue to another status by applying a transition.

1. Issue - The issue to move. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Transition - The transition to apply, for example from To Do to In Progress. Select the issue first and then choose the transition from the list, or map a transition Id returned by Get Transitions. Only transitions available for the current status of the issue can be applied.

​

Update Comment

Changes the text of an existing comment on a Jira issue.

1. Issue - The issue that holds the comment. Select the issue, map it from a previous step, or enter its key, for example “PROJ-123”. The key is shown at the top of the issue in Jira.
2. Comment - The comment to update. Select the issue first and then choose the comment from the list, or map the comment Id returned by a previous step, such as Get Comments.
3. Comment Text - The new text of the comment, in plain text. It replaces the existing text.
4. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Notify Users, Override Editable Flag (needs Jira admin permissions), Expand, Visibility Type (enter group or role) and Visibility Name.

​

Update Component

Updates an existing component of a Jira project.

1. Project - The project that holds the component. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. Select it first to load its components.
2. Component - The component to update. Choose it from the list, or map the component Id returned by Get Project Components.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Assignee Type, Description, Lead Account Id and Name (must be unique in the project).

​

Update Custom Field Options (Context)

Updates the options of a custom field in a field context.

1. Custom Field - The custom field whose options you want to update. Select it from the list, or enter its Id, for example “customfield_10000”.
2. Context - The field context that holds the options. Select the custom field first and then choose the context, or enter the context Id.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds Options: for each option, enter its Option Id, the new Value, and whether it is Disabled.

​

Update Version

Updates an existing version (release) of a Jira project.

1. Project - The project that holds the version. Select the project from the list, map it from a previous step, or enter its key, for example “PROJ”. Select it first to load its versions.
2. Version - The version to update. Choose it from the list, or map the version Id returned by Get Project Versions.
3. Add Field - Click Add Field to add optional fields. To learn more, click here.

Add Field adds these optional fields: Archived, Description, Expand (operations, issuesstatus, driver or approvers), Move Unfixed Issues To (the self link of the target version), Name (must be unique in the project), Release Date and Start Date (ISO 8601, for example 2027-12-31), Released and Driver.

​

Send API Request

This activity allows you to send a custom API request directly to Jira’s API. Use it for Jira features that the actions above don’t cover.

1. Base Url - The root URL of the Jira API. It is filled in from your Jira connection and can’t be edited here.
2. Relative url - You can specify additional path segments or parameters that need to be added to the end of the Base Url. This allows you to customize the specific request you want to perform.
3. Method - Select the HTTP method (e.g., Get, Post, Put, Delete, Patch). The default is POST.
4. Body Type - Defines the format of the data in the body of your request. The default, application/json, means the body contains a JSON-formatted payload.
5. Body - Contains any data that is being sent to the server.
6. Add Headers - Additional metadata about the request, such as the type of data Engini can accept, the length of the request body, and authentication information.
7. Add Queries - The query refers to the parameters or data that are included in the URL of an HTTP request to provide additional information or instructions to the server.

Engini adds your connection’s credentials to every request as an Authorization header, so you don’t need to add them to the headers. For the full list of endpoints, see the Jira Cloud platform REST API reference.