> ## Documentation Index
> Fetch the complete documentation index at: https://hoopdev-fix-add-missing-mechanic-for-session-download-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira

> Automate change management and security workflows by integrating Jira with your infrastructure access requests.

<Frame>
  <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-1.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=01b65a58d386c434707480f243a835c3" width="1360" height="700" data-path="images/integrations/jira-1.png" />
</Frame>

Hoop.dev's Jira integration transforms infrastructure access requests into automated Jira workflows, streamlining change management and security processes for your organization.

## Key Features

### Automated Change Management

* Automatically create and track Jira tickets for every infrastructure access request
* Maintain compliance with audit-ready change management records
* Reduce manual documentation and administrative overhead

### Seamless Workflow Integration

* Link access requests directly to Jira projects and request types
* Append contextual information from Hoop.dev sessions to Jira issues
* Support for custom and preset field mappings

### Flexible User Prompts & Data Collection

* Request additional information from users during access workflows
* Map manual or automated data to Jira fields for richer tickets

### CMDB & Asset Management Support

* Relate access requests to Configuration Management Database (CMDB) objects
* Automate asset linking and enforce asset-based workflows (requires Jira Assets)

## Benefits

* **Compliance:** Ensure every access request is tracked and auditable
* **Efficiency:** Eliminate manual ticket creation and reduce operational friction
* **Security:** Keep security and development teams in sync with real-time updates
* **Visibility:** Gain a complete audit trail of access and change events

## Integration with Other Features

Jira integration works seamlessly with other Hoop.dev features:

* **Guardrails:** Enforce policy and track exceptions via Jira
* **Session Recording:** Link session logs to Jira tickets for full traceability
* **Access Control:** Automate approvals and reviews through Jira workflows

## Configuration

To get started, enable the Jira integration in the Integrations section of your Hoop.dev instance.\
For a step-by-step setup and advanced options, see [Advanced Configuration](#advanced-configuration).

***

## Advanced Configuration

### Prerequisites

* A Hoop.dev account (managed or self-hosted)
* Administrator access in both Hoop.dev and Jira Cloud

### Quickstart

<Steps titleSize="h3">
  <Step title="Enable Jira integration">
    In the Integrations section (on the main sidebar), go to Jira and enable the integration to configure your credentials.

    <Frame>
      <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-2.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=032848e1d773c945d635bef976efb61f" width="1440" height="832" data-path="images/integrations/jira-2.png" />
    </Frame>

    <Info>For more information about these fields check [Jira Integration](#jira-integration) fields.</Info>
  </Step>

  <Step title="Create templates">
    With Jira Integrations enabled, your organization has access to Jira Templates on the main sidebar.

    <Frame>
      <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-3.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=8eb13a6c177c15d1f562e30b52241b14" width="1440" height="832" data-path="images/integrations/jira-3.png" />
    </Frame>

    To create a Jira Template, fill out the following information:

    * **Integration details:** Name, Description, Project Key, and Request Type.
      <Info>For more information about how to get Jira information check [Jira Templates](#jira-templates).</Info>
    * **Automated Mapping:** Append additional information to created Jira tickets when executing commands in a connection.
      <Info>For more information about available hoop.dev fields, check [Automated Mapping](#automated-mapping).</Info>
    * **Manual Prompt:** Request additional information from users when executing commands to be appended to created Jira tickets.
      <Info>For more information, check [Manual Prompt](#manual-prompt).</Info>
    * **Configuration Management Database (CMDB):** Optionally relate CMDBs and hoop.dev services.
  </Step>

  <Step title="Adding templates to a connection">
    <Frame>
      <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-4.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=75de4129d3bf7ed494b48a6c28bf0b4a" width="1128" height="1158" data-path="images/integrations/jira-4.png" />
    </Frame>

    While creating or configuring a connection, navigate to <code>Advanced Settings</code> and select a Jira Template.
    <Info>To keep your default workflow, Review option must be enabled for this connection. Connections without Review enabled will mark Jira tickets as done after executing a command.</Info>
  </Step>

  <Step title="Executing session">
    When a command is executed in a connection with a Jira Template, all configured information is checked (and requested, if needed) and appended to the session while a Jira ticket is created to the workflow.
  </Step>
</Steps>

***

### Jira Integration Fields

#### Jira Instance URL

**url** (`string`)\
Check [How to find your Jira URL](https://confluence.atlassian.com/jirakb/how-to-find-your-site-url-to-set-up-the-jira-data-center-and-server-mobile-app-954244798.html).

#### User Email

**email** (`string`)\
User email of Jira account to be connected with hoop.dev services.\
<Info>To ensure compatibility we recommend using a Jira admin account.</Info>

#### User API Token

**apiToken** (`string`)\
Go to <code>Atlassian Account > Security > API Tokens</code> or access [API Tokens](https://id.atlassian.com/manage-profile/security/api-tokens) to manage your API Tokens.

***

### Jira Templates

#### Project Key

**projectKey** (`string`)\
The ID or key of the Jira project.

<Frame>
  <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-5.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=66b71f00bae4d1bc7acf29134744aab7" width="2212" height="1305" data-path="images/integrations/jira-5.png" />
</Frame>

<Info>This field is case sensitive, make sure you have the right information.</Info>

#### Request Type

**requestTypeId** (`string`)\
The ID of the customer request type.

<Frame>
  <img src="https://mintcdn.com/hoopdev-fix-add-missing-mechanic-for-session-download-button/CSN3Tfze1AaWBPxZ/images/integrations/jira-6.png?fit=max&auto=format&n=CSN3Tfze1AaWBPxZ&q=85&s=ee331313f7ecad366ea4b6777397a5e7" width="2212" height="1305" data-path="images/integrations/jira-6.png" />
</Frame>

```sh theme={null}
# the ID is included at the end of the URL
# 10005: requestTypeId

https://yourcompany.atlassian.net/jira/servicedesk/projects/PROJ/settings/issuetypes/10005
```

<Info>This field is case sensitive, make sure you have the right information.</Info>

***

### Automated Mapping

Appends additional information to Jira cards when executing commands in a connection.

| Field           | Values   | Usage                                                   |
| --------------- | -------- | ------------------------------------------------------- |
| **Type**        | Preset   | Relates hoop.dev fields with Jira fields.               |
|                 | Custom   | Appends a custom key-value relation to Jira cards.      |
| **Jira Field**  | `string` | Jira key used to store appended value (case sensitive). |
| **Value**       | `string` | Value related to Jira field key.                        |
| **Description** | `string` | Optional information used to identify a mapping item.   |

**Preset values include:**\
Session ID, User Email, User ID, User Name, Connection Type, Connection Name, Connection Tags, Session Status, Session Start Date, Session Type, Session Script

***

### Manual Prompt

Requests manual input from users to get additional information when executing commands in a connection.

| Field           | Values    | Usage                                                                     |
| --------------- | --------- | ------------------------------------------------------------------------- |
| **Label**       | `string`  | Text input label presented for users.                                     |
| **Jira Field**  | `string`  | Jira key used to store appended value (case sensitive).                   |
| **Description** | `string`  | Optional information used to identify a mapping item.                     |
| **Required**    | `boolean` | Define if the input information is required before executing the command. |

***

### Configuration Management Database (CMDB)

Automates an advanced relation between CMDB files and hoop services.\
<Info>If information is not matched with CMDB, required information will be requested to be manually filled by the user before executing the command.</Info>

| Field           | Values    | Usage                                                                     |
| --------------- | --------- | ------------------------------------------------------------------------- |
| **Label**       | `string`  | Text input label presented for users.                                     |
| **Jira Field**  | `string`  | Jira key used to store appended value (case sensitive).                   |
| **Value**       | `string`  | Value related to Jira field key.                                          |
| **Object Type** | `string`  | An object type represents a group of similar objects.                     |
| **Description** | `string`  | Optional information used to identify a mapping item.                     |
| **Required**    | `boolean` | Define if the input information is required before executing the command. |

<Info>Learn more about [Object Types](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-object-types/)</Info>

#### CMDB Configuration

To manage your custom CMDB fields, check [Jira Service Management Support](https://support.atlassian.com/jira-service-management-cloud/docs/set-up-the-assets-object-field/).\
<Info>An Enterprise or Premium account is needed in order to get Jira Assets.</Info>

***

### API Permissions

Jira integration endpoints. If using a token with a more specific scope, ensure you have access to these endpoints.

#### Jira Instance API Permissions

**POST**

```sh theme={null}
https://yourinstance.atlassian.net/rest/servicedeskapi/request
```

**GET**

```sh theme={null}
https://yourinstance.atlassian.net/rest/api/3/issue/{issueKey}/transitions
```

**POST**

```sh theme={null}
https://yourinstance.atlassian.net/rest/api/3/issue/{issueKey}/transitions
```

#### Assets API Permissions

**GET**

```sh theme={null}
https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/aql
```

**GET**

```sh theme={null}
https://yourinstance.atassian.net/rest/servicedeskapi/assets/workspace
```

***

### Troubleshooting

Common issues and their solutions:

* **Token Issues:** Ensure your API token has the correct permissions
* **Service Desk ID/Project Key Errors:** Check numbers or case sensitivity and verify if the project exists
* **Request Type Mismatches:** Confirm the exact request type name in Jira settings