Jira Integration

Configure Jira integration to create and manage tickets for vulnerabilities from workflows or manually.

Configuration¶

Create a new Jira integration¶

1. Go to the Integrations page from the left navigation menu.

2. Click the Jira integrations card in the Ticketing section.

3. Click + Create new integration.

4. Select your authentication method:

   • Jira Cloud: For cloud instances (e.g., https://example.atlassian.net)
   • Jira Server: For self-hosted Jira instances

5. Fill in the form based on your authentication method:

   For Jira Cloud:

   • Name: A name to identify this integration
   • Jira instance's URL: Your Jira Cloud URL (e.g., https://<organization-name>.atlassian.net)
   • Jira API token: Generate an API token from your Jira account
   • Jira account email: The email used to generate the API token

   

   For Jira Server:

   • Name: A name to identify this integration
   • Jira instance's URL: Your Jira Server URL (e.g., https://jira.example.com)
   • Username: Your Jira username
   • Password: Your Jira password

   

6. Click Validate Credentials to verify the connection.

   The validation process tests your credentials by connecting to your Jira instance and fetching projects. Check the validation logs to see the results.

7. Click Connect with JIRA to create the integration.

To find your organization name for Jira Cloud, go to the Atlassian administration page > Click on Settings, then search for "Organization name".

Credential Validation¶

The Validate Credentials button tests your connection by fetching projects from your Jira instance.

When Validation Succeeds		When Validation Fails
When validation succeeds, you'll see: • Status: "All good!" • A list of projects found in your Jira instance		When validation fails, check the validation logs for error messages. Common issues: • Invalid credentials: Verify your API token (Cloud) or username/password (Server) • No projects found: Ensure your account has access to at least one project • Connection issues: Verify the instance URL is correct and accessible

Edit a Jira integration¶

1. Go to the Integrations page from the left navigation menu.
2. Click the Jira integrations card in the Ticketing section.
3. Click the Edit (pen icon) button next to the integration you want to edit.
4. Update the fields you want to change.
5. Click Update JIRA Integration to save.

Delete a Jira integration¶

1. Go to the Integrations page from the left navigation menu.
2. Click the Jira integrations card in the Ticketing section.
3. Click the Delete (trash icon) button next to the integration you want to delete.

Using Jira in Workflows¶

Jira can be used as an export action in workflows to automatically create tickets when workflow conditions are met.

Configuration¶

When creating or editing a workflow:

1. Go to Workflows → Create (or edit an existing workflow)
2. In the Actions step, add an Export action
3. Select Jira as the integration type
4. Select your Jira integration from the dropdown
5. Configure the following:

Project and Issue Type¶

• Project: Select the Jira project where tickets will be created
• Issue Type: Select the issue type (e.g., Bug, Task, Story)
• Parent Ticket (optional): Optionally select a parent ticket to create subtasks

Default Mappings¶

The backend automatically fills the following Jira fields for every ticket created:

• Summary: Set to the issue's full name

• Description: Automatically populated with:

  - Issue context (AI-generated context if available, otherwise the standard context)
  - Remediation steps (AI-generated remediation if available, otherwise the default remediation)
  - Link to issue in Escape.tech
  

If you add a static mapping for the description field, your custom content will be prepended to the automatically generated description.

Property Mappings¶

Property mappings allow you to map Escape properties to Jira fields dynamically based on the issue data.

Available Escape properties for mapping:

Issue Properties:

• Severity
• Created At
• Name
• Category
• Context
• Status
• Remediation
• Targets
• Link in All Issues
• Link in Asset
• Link in Scan
• Link in Profile

Profile Properties:

• Profile Name
• Profile Scanner Kind

Asset Properties:

• Asset Name
• Asset URL
• Asset Tags
• Asset External URL
• Asset Type
• Asset Class

Custom Rule Properties:

• Custom Rule Name
• Custom Rule Link

For certain fields (Severity, Category, Status, Asset Class, Asset Tags, Asset Type), you can configure value mappings. This allows you to map specific Escape values to specific Jira field options. For example, you can map "Critical" severity to "Highest" priority in Jira.

Static Properties¶

Static properties mappings allow you to set fixed values for Jira fields regardless of the Escape issue properties. This is useful for fields that should always have the same value, such as assigning tickets to a specific team or setting a default component.

Required Fields¶

The system automatically detects required fields for the selected project and issue type. If any required fields are not mapped (either through property mappings or static mappings), a warning will be displayed listing the unmapped required fields.

Usage¶

Creating Tickets from Workflows¶

When a workflow is triggered and includes a Jira export action, tickets are automatically created in Jira according to the configured mappings.

Creating Tickets Manually¶

You can also create Jira tickets manually from the Ticketing sidepanel on any issue. This uses workflows configured with Jira export actions.

To create a ticket:

1. Navigate to an issue sidepanel
2. Open the Ticketing tab
3. Select a workflow that includes a Jira export action
4. Click Create Ticket

The workflow's Jira export action configuration (project, issue type, mappings, etc.) will be used to create the ticket.

Filtering Issues by Jira Ticket Status¶

You can filter issues in the All Issues page to show only those with or without Jira tickets.

To filter issues by Jira ticket status:

1. Navigate to the All Issues page
2. Open the filters panel
3. Use the Jira Ticket filter to select:
   • Created: Shows only issues that have a linked Jira ticket
   • Absent: Shows only issues that do not have a linked Jira ticket

This filter helps you:

• Track which issues have been ticketed in Jira
• Identify issues that still need tickets created
• Monitor ticket creation coverage across your issues