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.
A Default API integration is provided in your account. This integration can be used for configuring users as well as alerts, however, we recommend adding a separate API Integration for each of your monitoring systems.
Opsgenie has built-in integrations for many management systems that make the integration configuration easier. Before using an API Integration, please check the existing Integrations, and feel free to suggest new integrations via the Contact Us page.
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.
- Specify who is notified for the alerts using the Teams field. Refer to Alert Notifications Flow.
An alternative for Step 2) and Step 3) is to add the integration from the Team Dashboard of the team which will own the 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.
- Check the modify configuration settings option to allow the integration to manage users, schedules, escalations, etc.
- Click Save Integration.
- An API Key is generated for the integration, copy the API Key and use in your API requests.
If the Owner of your Opsgenie account has not verified their email yet, users within your organization will not be able use API integrations.
Integration advanced settings consist of many different alert scenarios. These scenarios are called Actions; and they specify how and when alerts can be created, closed, acknowledged. etc. There are default actions provided by Opsgenie, but you can customize them and add as many actions of your own as you like. You can, for example, have three Create Alert actions, which means the data that comes to Opsgenie is evaluated against these three scenarios in order and if one of them has a match, a new alert is created.
Click "Advanced Settings" to switch or modify actions, then save your changes.
Refer to Integrations Framework for more information.
Dynamic fields (custom priority, payload, url, and headers) are not available for API integration.