Skip to main content

Opsgenie alert

Reading time: 0 minute(s) (0 words)

The OpsGenie alert method sends alerts through Opsgenie to notify whenever an incident is triggered.

Authentication​

Two authentication methods are supported for Opsgenie API integration:

  • Basic is a base64 hash created from the API Key, for example, YTU5ODNiZjYtZTM3OC00Yzk3LWE2YWItOGJlMzU4OWUxOTBm.

  • GenieKey (default) only requires the API Key obtained directly from the Opsgenie panel, so it is easier to use.

The choice between the two authentication methods is offered for convenience, as some users may only have access to one of the methods.

Creating Opsgenie API Key​

  1. Log in to your Opsgenie account.

  2. Go to Teams in the top navbar, then click the Add team button:

Opsgenie key - step1
Image 1: Add a new team to your Opsgenie account
  1. Hover over and click the name of the team that you've created:
Opsgenie key - step2
Image 2: Go to Opsgenie team details
  1. Go to Integrations in the left sidebar, and click the Add integration button:
Opsgenie key - step3
Image 3: Create an Opsgenie integration
  1. Click the API icon:
Opsgenie key - step3
Image 4: Add opsgenie API key
  1. Copy your Opsgenie API Key:
Opsgenie key - step3
Image 5: Opsgenie API key for the Nobl9 integration

Known limitations​

Currently, Nobl9 doesn't return the severity level when an OpsGenie alert is triggered.

Configuring the Opsgenie alert method​

You can configure your Opsgenie alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

Nobl9 UI​

To set up the alert method in the Nobl9 UI, follow these steps:

  1. Navigate to Integrations > Alert Methods.
  2. Click .
  3. Click the relevant Alert Method icon.

Then, in the OpsGenie Configuration Wizard:

  1. Enter the URL (mandatory).
    The URL must start with https://.

  2. Choose the Basic or GenieKey type of Authentication Method from the drop-down list.
    The default value is GenieKey. For more information, refer to the Authentication section.

  3. Enter the API Key (mandatory).
    Paste the API Key from Opsgenie. For more information, refer to the Authentication section.

  1. Select a Project.
    Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses the default project.
  2. Enter a Display Name.
    You can enter a user-friendly name with spaces in this field.
  3. Enter a Name.
    The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example, my-alert-method-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result.
  4. Enter a Description.
    Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
  5. Click Add Alert Method.

YAML configuration for Opsgenie​

Here’s an example of adding an Opsgenie alert through YAML (GenieKey):

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: opsgenie-notification-key
  displayName: Opsgenie notification with GenieKey
spec:
  description: Sends HTTP request to Opsgenie
  opsgenie:
    auth: GenieKey eb243592-faa2-4ba2-a551q-12345565c889
    url: <https://api.opsgenie.com>

Testing the Opsgenie alert method in the UI​

You can test alert methods for all notification services supported by the Nobl9 platform through the UI.

To verify the correctness of your alert method configuration:

  1. Navigate to Integrations > Alert Methods.
  2. Click the required alert method.
    Its Details page opens.
  3. Click Test under the alert method name:
    • For the correct configuration, Nobl9 displays Test completed successfully! under the button
    • Otherwise, Nobl9 displays the Test failed message, specifying what is set incorrectly

OpsGenie alert method | Terraform documentation

Last updated on
On this page