Configuring Opsgenie

Opsgenie is fully integrated with Uptime.com to allow 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 an Opsgenie account at https://www.opsgenie.com/. Uptime.com requires the following:

• API Endpoint - Uptime.com autofills this field
• API Key
• Name for the integration

Integration Functionality

Integration with Opsgenie allows for the following:

• When an alert is created in Uptime, an alert is created in Opsgenie automatically through the integration.
• When the alert is cleared on Uptime, the related alert is resolved in Opsgenie.   

Table of Contents

• Integration Setup
• Adding Other Parameters
• Assign Integration to Contacts
• Assign Integration Contact to a Check
• Test Your Integration

Integration Setup

Return

First, login to your Opsgenie account, and visit the Opsgenie Uptime Integration page. Copy the API Key you find there, as depicted below:

For Free and Essentials plans, you can only add the integrations from the Team Dashboards, please use the alternative instructions given below to add this integration.

Next, specify who is notified of Uptime alerts using the Teams field. Auto-complete suggestions are provided as you type.

You can also add the Integration from the Team Dashboard of the team which will own the Uptime Integration. To add an Integration directly to a team, navigate to the Team Dashboard and open Integrations tab. Click Add Integration and select the integration that you would like to add.

Click Save Integration.   

Return to Uptime.com. In order to activate the integration of OpsGenie within your Uptime account, you will go to Notifications>Integrations, then click New Profile. Select  OpsGenie as the Provider Type.

Paste the API Key copied previously into the "API Key" field, Name this Integration, and then click Save.

Please Note: For Free trial accounts you would need to adjust the API Endpoint field that is auto-generated in the Uptime.com OpsGenie setup window. Replace "uptime" in the endpoint and append with the Integration(API) name generated by OpsGenie.

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

Adding Other Parameters

Return

This section will instruct you on adding “Notes” and “Tags” created in Uptime.com.

In some cases, you will need a configured Uptime.com integration within OpsGenie to continue depending on your preferred use case.

Below is the logic by which the tags in OpsGenie will be transferred:

1. If the "Tags" field is set in the integration (OpsGenie side), then these Tags will be used in the created OpsGenie alert by default; otherwise

2. If the "Tags" field on the check is available and the integration is empty, these Tags will be used but will not override any tags set on the integration; otherwise

3. The Tags value in the OpsGenie alert will be blank.

To set the tags field within the integration (OpsGenie side), proceed as follows:

Click the Settings cog, followed by Configured Integrations. Locate the integration you have configured and click on it to open the integration settings.

Click Advanced on the top right-hand side and scroll to the Alert Fields, where you can add Tags and Notes programmatically using the following commands:

Tags:

{{_payload.data.service.tags.substringBetween("[", "]")}}

Notes:

{{_payload.data.service.msp_notes}}

You can learn about customizing parameters using this support article on Draggable Fields from OpsGenie.

The fields usable in _payload are identical to those used in the Uptime.com webhook. Please refer to this document for a full list. 

Assign Integration to Contacts

Return

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. 

You can designate a new contact from within the integration setup. Simply enter the name of your new contact into the Assign to Contacts field, and select it as depicted below:

Uptime.com will create a new contact and assign the integration to it. You can find this contact when you click Notifications > Contact.

Assign Integration Contact to a Check

Return

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

Return

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