Configuring Jira Service Desk

Jira Service Desk is a proprietary issue tracking product developed by Atlassian which allows bug tracking and agile project management. The Uptime.com integration allows you to push alerts to their platform, and we have worked together to make the integration seamless. To get started, you will first need to set up a Jira account at https://www.atlassian.com/software/jira.

Integration Functionality

  • When an alert is created within Uptime.com, an Incident is created in your Jira Service Desk for a specific project.
  • The alert can be customized with additional labels, and customized fields, to help prioritize and organize incidents related to Uptime.com checks.

Table of Contents

Integration Setup

A series of steps are required to complete the Integration with Jira, and you will need to switch between Jira Service Desk and Uptime.com at various stages. Follow these steps to complete your Integration setup.

In order to activate the integration of Jira within your Uptime account, you will go to Notifications>Integrations, then click New Profile. Select Jira Service Desk as the Provider Type when adding a new push notifications profile.

required-values.png

required-values2.png

A screenshot of all required values.

Step 1: Obtain your API Key

Log in to Jira Service Desk and go to https://id.atlassian.com/manage/api-tokens. Click Create API Token, then name your API Token. Copy it and return to Uptime.com. Paste the API Token into the corresponding field, and enter the email address you used to register with Jira.

Step 2: Determine Your Jira Service Desk Subdomain

Return to your Jira Service Desk. Copy the beginning part of the address/URL from the top of your browser. It will look like: https://your-domain.atlassian.net. Return to Uptime.com and paste this information into the Jira Subdomain field.

Step 3: Setup Your Jira Service Desk Project for Uptime.com Alerts

Copy the Project Key and Paste it into Uptime.com

While logged into your Service Desk, click Project Settings (the cog icon) from the menu, and then choose Details from the subsequent menu. Copy the value shown in the Key field (Example value: SMPSRVDESK), then return to Uptime.com. Paste the Key into the Project Key field.

Ensure "Incident" Issue Type is Enabled

While logged into your Service Desk click Project Settings (the cog icon) from the menu, and then choose Issue Types from the subsequent menu. If the "Incident" issue type is not already included in the current scheme, choose "Actions > Edit Issue Types" and enable the "Incident" type.

Step 4 (Optional): Create Custom Field(s) to Receive Additional Values

Go to your Jira homepage and select Jira Settings (cog icon) from the menu. Select Issues and then Custom Fields from the next two menus. Click Add custom field and follow the dialogs to create your field. In this case, configure a Custom Text Field to receive the account name.

NOTE: Custom fields are always optional, but they allow you to add additional specific values to Jira issues created by Uptime.com alerts.

Finally Edit your new field from the field list shown, and then you can copy the Custom Field ID (the last number in your browser's address/URL bar).

E.g.: https://your-domain.atlassian.net/.../?customFieldId=10042

Visit Jira Support documentation for more information on creating Custom Fields.

Once you've configured your Jira integration, you will need to assign it to a contact and make sure that contact is notified when a Check fails.

Assign Integration to Existing Contacts

To add your integration to an existing contact, click on or type the name of the contact into the Assign to Contacts field within the integration setup screen.

Create New Contacts for the Integration

Adding a dedicated or new contact cannot be done within the integrations screen. To do so first, click Notifications>Contacts. You can select New Contact, or add your integration to an existing contact.

Select Jira Service Desk from the Push Notifications field within the New Contact screen.

Assign Integration Contact to a Check

If you have created a new or dedicated contact for your integration, you will need to add it to specific checks. If you have assigned the integration to a contact that is already assigned to one (or more) checks, you may skip this step.

Return to your Check’s Edit screen and assign this contact to the Contacts field to be notified of a downtime event. Alert data will appear in real time.

Test Your Integration

Test your integration with one of the following two options:

  1. Force the Check assigned to your Integration to fail by altering it (HTTPS checks can use a misspelling of the domain, for example)
  2. Click Notifications>Contacts, then click Actions>Test to send a test to the Contact

 

Test.png