OpsGenie (Webhook Integration)
The OpsGenie integration allows Alerts to be delivered to OpsGenie via the Default API Integration.
What does Opsgenie offer Apica Synthetic users?
Using Opsgenie's Apica Synthetic integration, Apica Synthetic sends alerts to OpsGenie with detailed information. OpsGenie acts as a dispatcher for Apica Synthetic alerts, determines the right people to notify based on on-call schedules– using email, text messages (SMS), phone calls, and iOS & Android push notifications, and escalates alerts until the alert is acknowledged or closed.
The Functionality of the integration
When an alert is created by Apica Synthetic Monitoring, an alert is created in Opsgenie automatically through the integration.
With OpsGenie, you can
Manage incidents and alerts
Manage incidents and the lifecycle of incidents
Correlate with other systems inside OpsGenie
OpsGenie Webhook Integration Overview
More Information
Integration Setup in OpsGenie
OpsGenie User Names
You must set User names (or specifically the OpsGenie User ID) to set up OpsGenie targets, both for visibility and for ownership of notes.
Step | Screenshot |
---|---|
Find User NameTo find the User Name for a particular user:
| |
Select Users in the sidebar menu
| |
Find the user name in the Name column. Your goal is to find the USER ID that is associated with the Name.
| |
| Â |
The same Process (for a User/User ID above) is used for finding and selecting the Team/Team ID
OpsGenie Team Names
You must set Team names (or specifically the OpsGenie "Team ID") to set up OpsGenie targets, both for visibility and for ownership of notes.
Step | Screenshot |
---|---|
Find Team NameTo find the Team Name for a particular team:
| |
Select Teams in the sidebar menu
| |
Find the team name in the Name column. Click the team to access the User ID in the browser: | |
 |
OpsGenie documentation
For more details, see the OpsGenie documentation on Alerting Recipients & Teams
Â
OpsGenie Integration
To use OpsGenie as a target for delivery:
You need to use the API Key found in OpsGenie.
The Default API will work fine, and you can create dedicated integrations if you want.
You will also need to set up teams and users to own the alerts.
Additionally, you need to configure escalations for alerts.
You can then use the configured OpsGenie options as the required parameters in the Synthetic Monitoring target.
Please Check with OpsGenie’s Documentation for the Latest Details & Processes
API Integration in the OpsGenie documentation.
The OpsGenie API Key
When setting up an Apica Alert Target you need the API Key for the target, you can find it in the OpsGenie Integration view.
Â
Viewing OpsGenie integrations
You can view details about any particular integration from the OpsGenie Integrations view where all the registered applications are listed.
Step | Screenshot |
---|---|
Open the OpsGenie Integration ViewOpen the Application Registry
| |
Â
| |
The details view for the integration is shown. | |
Get the OpsGenie API KeyThe OpsGenie Application Registry contains a list of applications that are registered for OAuth authorization. The API Key will be listed within the selected Configuration
|
Set Up OpsGenie Alert Escalation Policies
OpsGenie Escalations
Step | Screenshot |
---|---|
Log into the OpsGenie site (https://app.opsgenie.com\)
| |
View Escalations
|
OpsGenie documentation
Please check the OpsGenie Escalations documentation for details.
Adding an OpsGenie Target
An OpsGenie Targets delivers alerts to a defined OpsGenie destination, via the OpsGenie Alert API.
Creating an OpsGenie Target
Step | Screenshot |
---|---|
To add an OpsGenie target
| |
Fill in the OpsGenie Webhook Target Dialog | |
Filling out the OpsGenie Webhook Target DialogTarget Name (Required)
Host (Required)
API (Required)
Message (Required)
| Â Alias
Description
Teams
Visible To
Actions
Tags
Details
Entity
Source
PriorityThe Priority indicates the urgency level of the alert. The default level in OpsGenie is P3.
User
Note
|
Once you are done, make sure you save your entries by Adding the OpsGenie Webhook Target
|
OpsGenie Alert Configuration Example
Host: https://api.opsgenie.com
API key: generated on the OpsGenie side
Message: %CHECK_NAME% Status Has Changed
Alias: %CHECK_NAME%
Description: a custom description for the alert which gives identifying information about the Alert.
Here is an example Description (some identifying information removed):
The status changed to *Error* (from Info) at *2022-07-05 14:54:39 (GMT-04:00)* for the check <https://wpm.apicasystem.com/BrowserResult/Details?checkId={checkId}&resultId={resultId}> Message: *Fullpage (FF) check 'test waitForText' failed [Error on 4 URL(s) Time (8272) was above upper limit (2000 ms)]* The check is run from *Check Location*.
Â
Can't find what you're looking for? Send an E-mail to support@apica.io