Jira Software – Alert Webhook Integration

  • 1 minute(s) read
Prev Next

Introduction

Jira Software enables teams involved in software development and maintenance to organize and collaborate. Users can track new features and bug fixes in terms of user stories, which gives a great deal to flexibility when working on a release.

This integration enables Catchpoint and Jira Software users to create new user stories in Jira when an alert is generated in Catchpoint. The details are sent over Alert Data Webhook using custom templates.

Prerequisites

  • Jira Software account.

Installation & Configuration

Set up in Jira Software

  1. Log in to your Jira Software account.
  2. Select the Project where the alerts data should be sent.
  3. Click on the Automation icon and choose Integration.
  4. Under New triggers, select Incoming webhook.
  5. Make note of the Webhook URL and click Save.
  6. Click on Add component.
  7. Click on New Action.
  8. Click on Create issue.
  9. Fill in the required details for creating an issue as below:
    1. Select the Project from the list.
    2. Select the Issue type, for my set up I have selected Story.
    3. Use macros to fill in Summary
      Catchpoint Alert - {{webhookData.description}} : {{webhookData.testId}} :  {{webhookData.TestName}}
    4. Use macros to fill in Description
      Label : {{webhookData.label}},
      event_type : {{webhookData.event_type}},
      description : {{webhookData.description}},
      Test Id : {{webhookData.TestId}},
      Test Name : {{webhookData.TestName}},
      Test URL :  {{webhookData.TestUrl}},
      time local : {{webhookData.time_local}},
      Node Name : {{webhookData.NodeName}},
      Node Client Address : {{webhookData.NodeClientAddress}},
      Node Mean : {{webhookData.NodeMean}}
      Waterfall Chart URL : {{webhookData.WaterfallChartURL}}
      performance Chart URL : {{webhookData.performanceChartURL}}
      scatterplot Chart URL : {{webhookData.scatterplotChartURL}}
    5. Click on Save.
  10. Name your automation.
  11. Click on Turn it on.

Note: Summary and Descriptions can be modified as per the use case, when modifying this section, remember to send the required data from Catchpoint Alert Data Webhook.

Setup in Catchpoint portal

  1. Navigate to Catchpoint portal.
  2. Click on Settings and choose API.
  3. Set up Alert Webhook:
    1. Provide a Name
    2. Set Status to Active.
    3. Provide the incoming webhook URL from Jira Software.
    4. Select Template for Format.
    5. Add a new template.
    6. Provide a template Name, select JSON and paste in below template.
      {"issues":["CATCHPOINT-1"], "data": { "event_type":"${switch("${NotificationLevelId}","0","trigger","1","trigger","3","resolve")}", "description":"${switch("${NotificationLevelId}","0","WARNING","1","CRITICAL","3","OK")}: ${TestUrl}", "client":"${TestName}", "testId":"${testId}", "client_url":"${TestUrl}", "label":"${testLabels}", "event_type":"${switch("${NotificationLevelId}","0","trigger","1","trigger","3","resolve")}", "description":"${switch("${NotificationLevelId}","0","WARNING","1","CRITICAL","3","OK")}", "TestId":"${testId}", "TestUrl": "${TestUrl}", "TestName": "${TestName}", "time_local": "${AlertCreateDateLocal}", "NodeName": "${NodeDetails('${NodeName}')}", "NodeClientAddress": "${NodeDetails('${NodeClientAddress}')}", "NodeMean": "${NodeDetails('${NodeMean}')}", "WaterfallChartURL":"${waterfallChartURL}", "performanceChartURL":"${performanceChartURL}", "scatterplotChartURL":"${scatterplotChartURL}" } }
    7. Select the newly created template.
    8. Click to Save the template.
  4. Click to Save the Alert Data Webhook.

Results

The Catchpoint alerts data will be sent to Jira Software and a user story will be created.
mceclip0.png