Get started with Opsgenie as a user
Learn how to configure your profile, get notifications from Opsgenie and view on-call schedules.
Create an API integration
What does Opsgenie offer API integration users?
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.
Functionality of the integration
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.
Opsgenie Client Tools
Any software system that is able to send HTTPS/JSON requests.
Using API Integration
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.
Click Save Integration.
An API Key is generated for the integration, copy the API Key and use in your API requests.
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.
You can add this integration from your team dashboard
If you're using Opsgenie's Free or Essentials plan, or if you’re using Opsgenie with Jira Service Management's Standard plan, you can only add this integration from your team dashboard as the Integrations page under Settings is not available in your plan.
Adding the integration from your team dashboard will make your team the owner of the integration. This means Opsgenie will assign the alerts received through this integration to your team only.
To do that,
Go to your team’s dashboard from Teams,
Select Integrations, and select Add integration.
Follow the rest of the steps to complete the integration.
If the Owner of your Opsgenie account has not verified their email yet, users within your organization will not be able use API integrations.
Advanced Settings
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 Use advanced integration settings for more information.
Dynamic fields (custom priority, payload, url, and headers) are not available for API integration.
Was this helpful?