Content Comparison

Github OG links

What does the integration offer?

Catchpoint sends alert notifications to Compass API, with detailed information. Compass 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 Compass automatically through the integration.
When alert notification level is changed for a Catchpoint test, the alert that created in Compass 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 Compass
Configure the integration in Catchpoint

Add a Catchpoint integration

Info

Bidirectional integrations aren’t supported in the Standard plan. All the other integrations are supported at a team level in Standard.
If you're using the Standard plan in Compass, you can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add a Catchpoint integration in Compass, 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 aname 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 Compass, 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 Compass. Following is an example of the alertCreateDate field added to the template:

JSON

Code Block

{
    "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)