Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The OpsGenie integration allows Alerts to be delivered to OpsGenie via the Default API Integration.

...

OpsGenie Webhook Integration Overview

  1. Set up OpsGenie Integration

  2. Add an OpsGenie Target

More Information

Integration Setup in OpsGenie

...

Step

Screenshot

Find User Name

To find the User Name for a particular user:

  • Go to the OpsGenie site (https://app.opsgenie.com) and login in as a user with administrator access

Image Modified

Select Users in the sidebar menu

  • Open the Users tab

Image Modified

Find the user name in the Name column.

Tip

Your goal is to find the USER ID that is associated with the Name.

  • To do this, click the User that will be for the target destination

Image Modified
  • Note the User ID now in the browser

  • Copy this for the Target User ID

Image Modified

...

Info

The same Process (for a User/User ID above) is used for finding and selecting the Team/Team ID

...

Step

Screenshot

Find Team Name

To find the Team Name for a particular team:

  • Go to the OpsGenie site (https://app.opsgenie.com) and login in as a user with administrator access

Image Modified

Select Teams in the sidebar menu

  • Open the Teams tab

Image RemovedImage Added

Find the team name in the Name column.

Click the team to access the User ID in the browser:

Tip

Your goal is to find the TEAM ID that is associated with the Team Name.

  • To do this, click the Team that will be for the target destination

  • Note the Team ID now in the browser

  • Copy this for the Target Team ID

...

To use OpsGenie as a target for delivery:

You can then use the configured OpsGenie options as the required parameters in the Synthetic Monitoring target.

...

Step

Screenshot

Open the OpsGenie Integration View

Open the Application Registry

  • Go to the OpsGenie site and Log In

    • Login in as a user with administrator access

Image RemovedImage Added

  • Select Integrations in the navigator

Image RemovedImage Added
  • Open the Configured Integrations tab

  • Click the desired Integration to view details

The details view for the integration is shown.

Image RemovedImage Added

Get the OpsGenie API Key

The OpsGenie Application Registry contains a list of applications that are registered for OAuth authorization.

The API Key will be listed within the selected Configuration

  • Copy the string from the API Key field

  • Return to setting the Apica Target to set up the OpsGenie target

Image RemovedImage Added

Set Up OpsGenie Alert Escalation Policies

...

Step

Screenshot

Log into the OpsGenie site (https://app.opsgenie.com\)

  • Login in as a user with administrator access

Image Modified

View Escalations

  • Select Escalations in the sidebar menu

Image Modified

OpsGenie documentation

...

Step

Screenshot

To add an OpsGenie target

  • Click the WebHook button

  • A blank target is created

  • Select OpsGenie

Image RemovedImage RemovedImage AddedImage Added

Fill in the OpsGenie Webhook Target Dialog

Image RemovedImage Added

Filling out the OpsGenie Webhook Target Dialog

Target Name (Required)

  • Enter the target name as the OpsGenie target in Synthetic Monitoring.

Host (Required)

API (Required)

  • The API Key is used to provide access to the OpsGenie API.

Message (Required)

  • The Message is an alert text; up to 130 characters long.

Alias

  • The Alias is an identifier for the alert, used for alert deduplication. There can only be one open alert for each alias in OpsGenie. For details, see the OpsGenie documentation: Alert Deduplication

Description

  • The Description field is typically used for detailed information about the alert, in addition to the message field.

Teams

  • The Teams section contains a list of OpsGenie teams that will receive notifications for the alert. Copy Team Names or ID:s from the OpsGenie Team Names/IDs view in OpsGenie.

Visible To

  • In the Visible To section, you can add OpsGenie teams and individual users that should have access to the alert, but not receive a notification.

Actions

  • The Actions section contains a list of actions the recipient can execute to respond to an alert. Details in their New User Guide.

Tags

  • Tags are labels used for grouping, identification, and categorization of alerts.

Details

  • In the Details section, you can add key-value pairs to use as custom properties for the alert.

Entity

  • The Entity field contains information about which domain or entity the alert belongs to. The entity can be an application, a server, or any other identifying information for the domain.

Source

  • In the Source field, you can specify an origin for the alert. The default value for Source is the IP address where the alert originated.

Priority

The Priority indicates the urgency level of the alert. The default level in OpsGenie is P3.

  • P1 - Critical

  • P2 - High

  • P3 - Moderate

  • P4 - Low

  • P5 - Information

User

  • The User field defines the owner of the OpsGenie Note attached to the alert. Copy User Names or User ID's from the OpsGenie Integration Users (IDs) view in OpsGenie.

Note

  • In the Note field, you can add information that will be added to the alert when it is created.

Once you are done, make sure you save your entries by Adding the OpsGenie Webhook Target

  • Click the Add WebHook OpsGenie Target button

  • Target is created, containing the selected user/targets.

Image ModifiedImage Modified

OpsGenie Alert Configuration Example

...