OpsGenie Integration

This guide goes through the steps necessary to integrate Backtrace with OpsGenie. Setting up integration with the OpsGenie ticketing system requires a valid OpsGenie REST API URL, as well as a valid username and password.

The steps in this process are:

  1. Generate an API Key
  2. Integration

Generate an API Key

In OpsGenie, click Integrations in the left navbar and click "Add" on "API". Note the API Key - you will need this in the next step - then modify the API integration as necessary, and click Save Integration.

Integration


To set up the integration, first go to the Configuration page within the Web Console:

Config


Next, select the project you want to add a integration for:

Select Project


Then click Integrations in the left-hand menu, then Create a New Integration on the right, and pick the integration:

Create Integration


These are the settings that you can configure for your OpsGenie integration:

Setting Required? Description
API Key Yes The API Key generated in OpsGenie Integrations
Message Yes The title of the OpsGenie alert
URL No The API endpoint URL. Defaults to https://api.opsgenie.com/v1/json/alertif omitted.
Teams No List of team names which will be responsible for the alert. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Recipients No Optional user, group, schedule or escalation names to calculate which users will receive the notifications of the alert. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Alias No Used for alert deduplication. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Actions No A comma separated list of actions that can be executed. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Source No Field to specify source of alert. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Tags No A comma separated list of labels attached to the alert. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Details No Set of user defined properties. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Entity No The entity the alert is related to. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
User No Default owner of the execution. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API
Note No Additional alert notes. This is passed on through to the OpsGenie API. For more information, see OpsGenie Alert API

OpsGenie


Next: After filling in the integration-specific settings, proceed to Common Settings to finish configuring the integration.