Jira

Jira provides bug tracking, issue tracking, and project management functions.

Integration with LogicHub

Connecting with Jira

To connect to Jira following details are required:

  • Label: Connection name.
  • Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.
  • URL: URL of the Jira server.
  • User: User name to log in with.
  • Password or API Token: Password or API Token to log in with. API Token is recommended. Also, only API Token will work if third-party sign-in is enabled in JIRA. For more information on how to generate an API token, click here.

Actions with Jira

Create Issue

This action creates a ticket with the specified details whenever the parent table has any results. The parent table's data is put into the ticket's description field.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Project: Select the Jira project to use for the new issue.
  • Title Column Name: Column name that contains the title of the issue to create.
  • Description Column Name: Column name that contains the description of the issue to create.
  • Type: Select Issue type.
  • Priority: Select issue priority.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: created ticket details

Create Issue V2

Creates a Jira issue for each row in the input table.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Project: Select the Jira project to use for the new issue.
  • Title Template: Jinja2 template for the issue title
  • Description Template: Jinja2 template for the issue description
  • Type: Issue type (example: Bug and Task)
  • Priority (Optional): Issue priority (example: Low, Medium, and Critical). If unselected default priority (configured in Jira) will be used.
  • Labels (Optional): Jinja2 templatized JSON array of string labels.
  • Other Fields (Optional): Jinja2 templatized JSON object of extra fields like Assignee. Refer to Get Account ID of Jira Users. For user field, emailAddress and displayName could also be used apart from the fields mentioned in the API.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: created ticket details

Create Issue with Optional Fields

Creates a Jira issue for each row in the input table.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Project: Select the Jira project to use for the new issue.
  • Title Template: Jinja2 template for the issue title.
  • Description Template (Optional): Jinja2 template for the issue description.
  • Type: Issue type (example: Bug, Task).
  • Labels (Optional): Jinja2 templatized JSON array of string labels.
  • Other Fields (Optional): Jinja2 templatized JSON object of extra fields like Assignee. Refer to Get Account ID of Jira Users. For user field, emailAddress and displayName could also be used apart from the fields mentioned in the API.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: created ticket details

Add Comment

Adds a comment to an existing Jira issue for each row in the input table.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Issue ID/Key Column Name: Column name containing the issue ID or key. The comment will be added to the specified issue.
  • Comment Body Template: Jinja2 template for the comment body.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null

Query Issues

This action queries Jira for tickets that match the given JQL.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Query: JQL query, with optional variable substitution denoted by column names in double braces {{ and }}.
  • Output Type (Optional): The action either returns one JSON per input row or one JSON per issue found or one JSON per issue found (Default: One JSON per issue found).
  • Max number of results (Optional): Maximum number of results to retrieve from JIRA, per query (Default is 1000 results).

Output of Action
JSON rows containing the following items:

  • has_error: True/False
  • error: message/null
  • other key fields of result

Get Issue

This action retrieves the Jira ticket for a given issue key.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Jira Issue ID/Key Column Name: Column name containing the issue ID or key of the Jira ticket to retrieve.
  • Download Attachment (Optional): Select option Yes/No to download attachments. Downloading attachments may take additional time (default is No).

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • other key fields of result

Update Status

This action updates the status of a given issue key.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Jira Issue ID/Key Column Name: Column name containing the issue ID or key. The specified issue's status will be updated.
  • Status Column Name: Column name containing the new status for the issue.

Output of Action

  • result: Transition successful.

Update Issue

This action updates the status of a given issue key.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Jira Issue ID/Key Column Name: Column name containing the issue ID or key. The specified issue will be updated.
  • Assignee Column Name (Optional): Column name that contains accountID of the new assignee of the issue.
  • Description Column Name (Optional): Column name that contains the updated description of the issue.
  • Other Fields (Optional): Jinja2 templatized JSON object of extra fields. 'assignee' and 'description' fields specified here will be ignored if they're provided above. To get accountID of users for Assignee, refer to Get Account ID of Jira Users. For user field, emailAddress and displayName could also be used apart from the fields mentioned in the API.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Updated successfully.

Upload Attachments

Upload attachment to a Jira Issue.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Jira Issue ID/Key Column Name: Column name containing the issue ID or key. Attachments will be added to the specified issue.
  • Attachment File IDs Column Name: Column name that contains file ids of the attachments to be attached to Jira issue. Example: column-value: 'asdfghjklqwerty,zxcvbnmqwerty'
  • Attachment Names (Optional): Column that contains new names to be given to the uploaded attachments. Example: column-value: 'triage-alerts1.csv,triage-alerts2.csv'. If not provided or the count of file-ids is more than file-names, file-id will be used as the name for the remaining files.

Output of Action
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Uploaded successfully.

Get Comments

Get Comments for an issue.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Issue ID/Key Column Name: Column name containing the issue ID or key. Comments of specified issues will be fetched.
  • Start At (Optional): Page Offset to start at (default '0').
  • Max Results (Optional): Max number of results on the page that should be included (default '50').
  • Order By (Optional): Specify the field on which comments should be ordered. (Default '-created' to get the latest comments first). '-' for descending.

Output of Action
JSON rows containing the following items:

  • has_error: True/False
  • error: message/null
  • other key fields of result

Link Issues

Links an issue to another issue.

Inputs to this Action

  • Connection: Choose a connection that you have created.
  • Issue Key Column Name (Inward): Column name containing the issue key of inward issue.
  • Issue Key Column Name (Outward): Column name containing the issue key of outward issue.
  • Issue Link Types: Select the type of Issue-link.

Output of Action
JSON rows containing the following items:

  • has_error: True/False
  • error: message/null
  • other key fields of result

Download Attachments

This action downloads the Jira attachments identified by attachment ID.

Inputs to this action

  • Connection: Choose a connection that you have created.
  • Jira Attachment ID Column Name: Column name containing the attachment ID to download.

Output of Action
JSON rows containing the following items:

  • has_error: True/False
  • error: message/null
  • other key fields of result

Get Account ID of Jira Users

Jinja template to be provided in Other Fields to set Assignee:

{
  "assignee": {
    "accountId": "{{account_id_column}}"
  }
}

accountId for a user can be fetched by using Web API integration and making call a call to Jira Users Search API https://<company-subdomain>.atlassian.net/rest/api/3/users/search


Did this page help you?