Create an API integration
Overview
What does the integration offer?
Through API integration, you can access Opsgenie services to create alerts and configure users, on-call schedules, and teams for third-party applications.
How does the integration work?
A default API integration comes with your Opsgenie account. You can use this integration to configure users as well as alerts. However, we recommend adding a separate API Integration for each of your monitoring systems.
Opsgenie has the built-in capability to integrate with many management systems, making the configuration easier. Before using API Integration, check our current list of supported applications; if you can’t find what you’re looking for, contact us.
Opsgenie Client Tools
Any software system that is able to send HTTPS/JSON requests.
Set up the integration
Add an API integration
Go to Settings → Integrations.
Run a search and select “API”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration. Learn how alert notifications flow in Opsgenie.
Select Continue.
The integration is saved at this point.Expand the Steps to configure the integration section and copy the API key for use in your API requests.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.
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 add this integration from your team dashboard only. The Integrations page under Settings is not available in your plan.
Go to Teams and select your team.
Select Integrations on the left navigation and then select Add integration.
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. Follow the rest of the steps in this section to set up 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.
Define rules for creating and processing alerts
The configuration of an API integration involves defining many different alert scenarios. These scenarios specify how and when alerts can be created, closed, acknowledged, etc. The integration comes with a default set of alert creation and processing rules; you can customize them and add as many rules of your own as you like. For example, you can add three rules for create alert, which means the incoming data is evaluated against these three scenarios in order, and if one of them matches, an alert is created. There’s a slight difference in how API integration works though - unlike in the case of other integrations, it only considers the rules for the specific endpoint you're working with. For instance, when you send a “Clear alert” request, it'll only check the rules under the 'Create alert' section and won’t keep cascading trying to match other alert processing rules if any.
Learn more about advanced integration settings.
Dynamic fields (custom priority, payload, URL, and headers) are not available for API integration.
Was this helpful?