DocsAPI ReferenceChangelog
BigPanda.ioOpen BigPandaRequest Demo

Jira Changes

The Jira Changes integration notifies BigPanda of any new or updated changes in your Jira Change Management, ensuring these changes are available for use in the RCA process with BigPanda's Root Cause Changes feature.

Suggest Edits

Supported Versions

Type

Authentication Type

Jira Cloud
Jira Server

Native App
Webhook

API Key and Bearer Token

Key Features

  • Native app to easily integrate BigPanda with Jira.
  • JQL filters to target your projects and issues for change management.
  • Easy configuration via the configuration form located in the BigPanda Jira app, where you can:
    • Map custom statuses in Jira to BigPanda statuses.
    • Map custom fields in Jira to BigPanda tags.
    • Hide any undesired fields from the BigPanda UI.

How It Works

The BigPanda Jira app creates a Jira webhook that sends BigPanda all new and updated issues matching the customer-provided JQL filter. The change data is processed and normalized according to the configuration provided in the BigPanda Jira app. The prepared change record is then sent to the BigPanda Console.

Data Models

BigPanda converts and organizes Jira issue information into tags.

Default Field Mapping

The table below outlines the default mapping of Jira fields to BigPanda tags. These can be customized in the app configuration.

BigPanda Tag

Jira Field

Description

identifier

key

The unique identifier for the change.

status

status.name

The change status.

start

created

When the change started.

summary

summary

Summary of the change.

end

resolutiondate

When the change ended.

Default Status Mapping

The table below outlines the default mapping of Jira statuses to BigPanda change statuses. These can be customized in the app configuration.

BigPanda Status

Jira Statuses

Description

Planned

[none]

A change has been planned but is not yet in progress.

In Progress

open, reopen, in progress

A change is currently in progress.

Done

resolved, done, closed

A change was resolved.

Canceled

[none]

A change was cancelled or aborted.

Managing the Integration

Prerequisites

  • Admin access to Jira.
  • Create and save a BigPanda API Key.
  • Create a Changes REST API integration and save the app key.

Jira Cloud

Installing the Jira App

  1. Log into your Jira instance.
  2. In the left panel, go to Jira Settings > Apps > Find new apps.
  3. Search for and install the BigPanda App.

Setup

  1. Go to Jira Home.
  2. Click the BigPanda App from the sidebar.
  3. Add the API, App key, and JQL Filter.
  4. Optionally fill out the additional configuration fields.
  5. Save your changes.

Configuration

Once the BigPanda Jira app is installed, you can configure it by clicking on BigPanda in the main Jira menu.

General Section

The General section allows you to specify the Jira field name for the following BigPanda tags:

  • start
  • end
  • summary

Status Names Section

The Status Names section allows you to specify:

  • The Jira field for the change status.
  • The mapping of Jira statuses to BigPanda statuses.

📘

Field Format

Provide a comma-separated list of Jira statuses for each BigPanda Status (ie: done, resolved, closed, completed)

Tags Section

By default, all Jira issue fields are mapped to tags in BigPanda using their field names.
Customize Jira field names and BigPanda tag names in the Tags section.

Metadata

BigPanda Changes allows you to hide specific tags from the Console without losing the ability to leverage these tags in correlation. To use the Metadata section to hide specific tags, provide a comma-separated list of the field names you wish to exclude.

Jira Server

Configuring the webhook

A webhook URL needs to be created with all the necessary query parameters to make sure BigPanda processes the Jira Issues correctly.

This table represents all the required and optional query parameters the webhook can leverage.

Query Parameter

Value Options

Description

api_key

required BigPanda API Key

app_key

required App key for the Change API integration.

override_status_field

true/false

required Overrides the default status field.

status_name

Jira field

If override_status_field is set to true, this parameter is required.

override_status_mapping

true/false

required Overrides the default status mapping.

status_mapping

URI encoded Object

Object keys: BigPanda Change statuses
Object value: Array of Jira statuses to match

See example below

If override_status_mapping is set to true, this parameter is required.

Reference default status mapping

start

Jira field

Overrides the default start field

end

Jira field

Overrides the default end field

summary

Jira field

Overrides the default summary field

tags

URI encoded Object

Object keys: Jira field
Object value: BigPanda tag name

This parameter allows you to provide a user friendly name to any Jira field.

metadata

URI encoded Array

Ex:
["jirafield"]

encoded:
%5B%22jirafield%22%5D

This list of Jira fields will hide from the BigPanda Console.

  1. Start with the base URL: https://inbound.bigpanda.io/jira/changes
  2. Add the required query parameters to the URL. Below a basic example of a fully formed URL
    https://inbound.bigpanda.io/jira/changes?api_key=1234567890&app_key=0987654321&override_status_field=false&override_status_mapping=false
  3. Add any additional query parameters to meet your desired configuration

📘

URL Encoding

For the status_mapping and tags parameters, it is required to URI encode the values. Here is an example of this encoding

Sample Status Mapping

{
  "Planned": ["approved", "in review"],
  "In Progress": ["pending"],
  "Done": ["done", "finished"],
  "Canceled": ["cancelled", "rejected"]
}

URI Encoded Object
%7B%22Planned%22%3A%20%5B%22approved%22%2C%22in%20review%22...

Note: All extra spaces must be removed prior to encoding the object

Creating the Webhook

  1. Log into your Jira instance.
  2. In the left panel, go to Jira Settings > System > Webhooks.
  3. Click on Create a Webhook
  4. Enter a name for the webhook
  5. Add your generated webhook from the previous step.
  6. Add a JQL Query to the webhook so that only the projects you want are pushed to BigPanda
  7. Check the Issue created and updated checkboxes.
  8. Click create at the bottom.

Uninstalling the Integration

Jira Cloud

  1. Uninstall the app by navigating to Jira Settings > Apps > Manage apps.
  2. Use the Uninstall button for the BigPanda App.

Jira Server

  1. Uninstall the app by navigating to Jira Settings > System > Webhook.
  2. Select the BigPanda webhook and click on the delete button

Updated 6 months ago