Integrate with Catchpoint

This article highlights a new alerting feature that's natively available in Jira Service Management which is gradually rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

What does the integration offer?

Catchpoint sends alert notifications to Jira Service Management API, with detailed information. Jira Service Management acts as a dispatcher for these alerts, determines the right people to notify based on on-call schedules– notifies them using email, text messages (SMS), phone calls and iOS & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

When an alert is created in Catchpoint, an alert is also created in Jira Service Management automatically through the integration.
When alert notification level is changed for a Catchpoint test, the alert that created in Jira Service Management is closed automatically.

Set up the integration

Catchpoint is an API-based integration. Setting it up involves the following steps:

Add a Catchpoint integration in Jira Service Management
Configure the integration in Catchpoint

Add a Catchpoint integration

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add a Catchpoint integration in Jira Service Management, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Catchpoint”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the API URL.
You will use this URL while configuring the integration in Catchpoint later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Catchpoint

To configure the integration of Catchpoint with Jira Service Management, complete the following steps:

In Catchpoint, go to Settings > API.
In the Alert API section, select Enable.
Select Add Endpoint.
Paste the API URL copied previously into Endpoint URL.
Select “Template” for Format.
Enter a name for the template. For example, “JSM”.
Select Add Endpoint.
Select “JSON” for Format.
Copy the contents of this text file and paste them into the template.
Select Save.

Customize Catchpoint alert templates for additional information for Jira Service Management. Following is an example of the alertCreateDate field added to the template:

JSON

{
    "testName": "${TestName}",
    "testId": "${TestId}",
    "testUrl": "${TestUrl}",
    "alertTypeId": "${AlertTypeId}",
    "productName": "${ProductName}",
    "clientId": "${ClientId}",
    "notificationLevel": "${switch("${notificationLevelId}","0","WARNING","1","CRITICAL","3","OK")}",
    "nodeName":"${nodeDetails("${nodeName}")}",
    "nodeServerAddress":"${nodeDetails("${NodeServerAddress}")}",
    "alertCreateDate":"${alertCreateDateUtc}"
}

You can use the {{_payload.variable_name}} variable for alert properties too. Read more about dynamic alert properties.

Sample payload sent from Catchpoint

Create Alert payload (in JSON format)

{
  "message": "WARNING - Yahoo Test",
  "testName": "Yahoo Test",
  "testId": "81093",
  "testUrl": "http://www.yahoo.com",
  "alertTypeId": "7",
  "productName": "tests",
  "clientId": "24",
  "notificationLevel": "WARNING",
  "nodeName": "New York - Level3",
  "nodeServerAddress": "98.139.180.149",
  "description": "Description"
}

Was this helpful?

It wasn't accurate

It wasn't clear

It wasn't relevant

Still need help?

The Atlassian Community is here for you.

Ask the Community