Opsgenie

View the on-call schedules, on-call participants as well as ability to create an incident directly with Opsgenie to enrich the operational engagement of your services within the catalog.

Summary - Creating a Opsgenie Credential

Create an API key. Copy the key to a secure location.
Go to configure8 app -> Settings -> Credentials -> Add Credential and select Opsgenie credential provider.
Set up name for the Credential and fill info based on this.
Hit Save. The credentials will be checked and a discovery job will start. Done!
You can now add it as a Plugin for your services.

Opsgenie makes on-call management easy. You can build and modify schedules and define escalation rules within one interface. Your team will always know who is on-call and accountable during incidents and have the confidence that critical alerts will always be acknowledged.

Prerequisite

API Integrations are used to access Opsgenie services, allowing you to integrate alerts, configure users, schedules, and teams on your Opsgenie account from external applications.

In order to get started with embedding your Opsgenie integration, you must create a new API key.

You can review the full instructions for create new API keys here.

To generate an API Access Key, login to your Opsgenie Console and:

Go to Settings → Integrations. Search for API and select Add.
Specify who is notified for the alerts using the Responders field. Refer to Alert Notifications Flow.
Check the modify configuration settings option to allow the integration to manage users, schedules, escalations, etc.

All requests of Who Is On Call API work under the Schedule domain. It means that, if you are using an apiKey that belongs to a team integration, that team must allowed to access given schedule. Otherwise, we would respond with 403 - Forbidden (Unauthorized) code. OpsGenie API

Click Save Integration.
An API Key is generated for the integration, copy the API Key and use in your API requests.

This will generate a unique API key. Store it in a secure location, as this is the only time the key is displayed in full. If you lose a key you will need to delete it and create a new one.

Creating a Opsgenie Credential

To connect your Opsgenie account to configure8, perform the following steps.

Get started by navigating to the Credentials page by clicking on the "lock" icon on the menu bar.

Next, select the Add Credential button.

From the Add Credential pop-up, select Opsgenie from the list of available providers.

Next, enter the information required for your credential

Name: a recognizable alias for the new credential
Account ID: This is the organization of your Opsgenie account.
API Key: This is the Opsgenie API Key you generated in the prerequisite section.

Select Save to create your Opsgenie credential in configure8. The configure8 app will automatically validate the credentials to make sure they work. If they do not, the credentials will not be saved and you will be prompted to fix them.

Configuring Opsgenie for your Services

Adding a Opsgenie plug-in to your service adds the on-call schedule and ability to create an incident to the sidebar on your service overview page. To add a Opsgenie plug-in to your service, start by selecting a service from your catalog Services listing.

From your service overview page, select the Add Plug-in button.

From the Plugins dialog, browse through the list of available plugins and select the Opsgenie plug-in by clicking on the Add button.

In the Plug-ins configuration wizard, select an existing credential to connect to the selected plugin provider. If you do not have an existing credential or would like to use a new credential, select the Add Credential button.

Next, enter the information required for your Opsgenie plug-in configuration.

Plugin Title: the title of the plug-in to display on the service overview page
Schedule identifier: This is the team schedule you would like to link to your service. configure8 will query Opsgenie for you and return the available schedules based on the API Key provided for you to easily select your desired schedule.

Once you have entered all the required configuration information, select Done. Your configured plug-in is added to your service overview page.