Transform your infrastructure access requests into automated Jira workflows. This integration helps teams:

  • Maintain compliance with automatic change management tracking
  • Reduce manual documentation work
  • Keep security and development teams in sync
  • Create audit trails automatically

​
Prerequisites

To get the most out of this guide, you will need to:

​
Quickstart

1

Enable Jira integration

In the Integrations section (on the main sidebar), go to Jira and enable the integration to configure your credentials.

For more information about these fields check Jira Integration fields.
2

Create templates

With Jira Integrations enabled your organization has access to Jira Templates on the main sibedar.

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

Integration details: Name, Description, Project Key and Request Type.

For more information about how to get Jira information check Jira Templates.

Automated Mapping: Append additional information to you created Jira tickets when executing commands in a connection.

For more information about available hoop.dev fields, check Automated Mapping.

Manual Prompt: Request additional information from users when executing commands to be appended to created Jira tickets.

For more information, check Manual Prompt.

Configuration Management Database (CMDB): An additional layer of relation between CMDBs and hoop.dev services. This information is optional.

3

Adding templates to a connection

While creating or configuring a connection, navigate to Advanced Settings section and select a Jira Template.

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.

4

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.

​
Jira Integration

​
Jira Instance URL

url string

Check How to find your Jira URL.

​
User Email

email string

User email of Jira account to be connected with hoop.dev services. It can be found going to Profile and Settings and needs to be the same used for the API Token.

To ensure compatibility we recommend using a Jira admin account.

​
User API Token

apiToken string

Go to Atlassian Account > Security > API Tokens or access API Tokens to manage your API Tokens.

​
Jira Templates

​
Project Key

projectKey string

The ID of the service desk whose customer request type is to be returned. You can get the ID by checking the URL in a portal ticket.

This can alternatively be a project identifier (Project Key). For Project Key go to Project settings > Details.

This field is case sensitive, make sure you have the right information.

​
Request Type

requestTypeId string

The ID of the customer request type to be returned. To find your Request Type ID go to Project settings > Request management > Request type and select the request type.

# the ID is included at the end of the URL
# 10005: requestTypeId

https://yourcompany.atlassian.net/jira/servicedesk/projects/PROJ/settings/issuetypes/10005
This field is case sensitive, make sure you have the right information.

​
Automated Mapping

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

FieldValuesUsage
TypePresetRelates hoop.dev fields with Jira fields.
CustomAppends a custom key-value relation to Jira cards.
Jira FieldstringJira key used to store appended value (case sensitive).
ValuestringValue related to Jira field key.
DescriptionstringOptional information used to identify a mapping item.

​
Preset values

  • Session ID
  • User email
  • User ID
  • User name
  • Connection type
  • Connection name
  • 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.

FieldValuesUsage
LabelstringText input label presented for users.
Jira FieldstringJira key used to store appended value (case sensitive).
DescriptionstringOptional information used to identify a mapping item.
RequiredbooleanDefine if the input information is required before executing the command.

​
Configuration Management Database (CMDB)

Automates an advanced relation between CMDB files and hoop services.

If information is not matched with CMDB, required information will be requested to be manually filled by the user before executing the command.

FieldValuesUsage
LabelstringText input label presented for users.
Jira FieldstringJira key used to store appended value (case sensitive).
ValuestringValue related to Jira field key.
Object TypestringAn object type represents a group of similar objects in an object schema.
DescriptionstringOptional information used to identify a mapping item.
RequiredbooleanDefine if the input information is required before executing the command.
Learn more about Object Types

​
CMDB Configuration

To learn how to manage your custom CMDB fields, check Jira Service Management Support.

An Enterprise or Premium account is needed in order to get Jira Assets.

​
API Permissions

Jira integration endpoints. In case of use of token with a more specific scope, make sure you have access to these endpoints.

​
Jira Instance API Permissions

POST

https://yourinstance.atlassian.net/rest/servicedeskapi/request

GET

https://yourinstance.atlassian.net/rest/api/3/issue/{issueKey}/transitions

POST

https://yourinstance.atlassian.net/rest/api/3/issue/{issueKey}/transitions

​
Assets API Permissions

GET

https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/object/aql

GET

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
Svix