Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

ASM supports the configuration of webhooks in order to deliver customized, automated messages to predefined endpoints. The information which is delivered to these webhook endpoints can be static or dynamic.

What Are Some ASM Webhook Features?

Apica integrates with 3rd-Party Alerting services, allowing companies using ASM to have alerts sent to the receiving management system of their choice.

📍 The incident alerts are PUSHED by ASM to the selected system endpoint.

  • The pushed data from ASM is either a Trigger or a Resolution of the alert.

The message can include dynamic Alerts Message Placeholders such as

  • Check Location

  • Check Description

  • Check Name

  • Date & Time of alert

  • Etc.

 OpsGenie

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

  1. Set up OpsGenie Integration

  2. Add an OpsGenie Target

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 Name

To find the User Name for a particular user:

  • Go to the OpsGenie site (https://app.opsgenie.com) and login in as a user with administrator access

Select Users in the sidebar menu

  • Open the Users tab

Find the user name in the Name column.

Your goal is to find the USER ID that is associated with the Name.

  • To do this, click the User that will be for the target destination

  • Note the User ID now in the browser

  • Copy this for the Target User ID

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 Name

To find the Team Name for a particular team:

  • Go to the OpsGenie site (https://app.opsgenie.com) and login in as a user with administrator access

Select Teams in the sidebar menu

  • Open the Teams tab

Find the team name in the Name column.

Click the team to access the User ID in the browser:

Your goal is to find the TEAM ID that is associated with the Team Name.

  • To do this, click the Team that will be for the target destination

  • Note the Team ID now in the browser

  • Copy this for the Target Team ID

OpsGenie documentation

For more details, see the OpsGenie documentation on Alerting Recipients & Teams

OpsGenie Integration

To use OpsGenie as a target for delivery:

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

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 View

Open the Application Registry

  • Go to the OpsGenie site and Log In

    • Login in as a user with administrator access

  • Select Integrations in the navigator

  • Open the Configured Integrations tab

  • Click the desired Integration to view details

The details view for the integration is shown.

Get the OpsGenie API Key

The OpsGenie Application Registry contains a list of applications that are registered for OAuth authorization.

The API Key will be listed within the selected Configuration

  • Copy the string from the API Key field

  • Return to setting the Apica Target to set up the OpsGenie target

Set Up OpsGenie Alert Escalation Policies

OpsGenie Escalations

OpsGenie escalations are required for Apica alerts to work and for groups and users to get notified about the alerts.

Step

Screenshot

Log into the OpsGenie site (https://app.opsgenie.com\)

  • Login in as a user with administrator access

View Escalations

  • Select Escalations in the sidebar menu

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

This is a complete Step-by-Step Guide to Add an OpsGenie Target

Step

Screenshot

To add an OpsGenie target

  • Click the WebHook button

  • A blank target is created

  • Select OpsGenie

Fill in the OpsGenie Webhook Target Dialog

Filling out the OpsGenie Webhook Target Dialog

Target Name (Required)

  • Enter the target name as the OpsGenie target in Synthetic Monitoring.

Host (Required)

API (Required)

  • The API Key is used to provide access to the OpsGenie API.

Message (Required)

  • The Message is an alert text; up to 130 characters long.

Alias

  • The Alias is an identifier for the alert, used for alert deduplication. There can only be one open alert for each alias in OpsGenie. For details, see the OpsGenie documentation: Alert Deduplication

Description

  • The Description field is typically used for detailed information about the alert, in addition to the message field.

Teams

  • The Teams section contains a list of OpsGenie teams that will receive notifications for the alert. Copy Team Names or ID:s from the OpsGenie Team Names/IDs view in OpsGenie.

Visible To

  • In the Visible To section, you can add OpsGenie teams and individual users that should have access to the alert, but not receive a notification.

Actions

  • The Actions section contains a list of actions the recipient can execute to respond to an alert. Details in their New User Guide.

Tags

  • Tags are labels used for grouping, identification, and categorization of alerts.

Details

  • In the Details section, you can add key-value pairs to use as custom properties for the alert.

Entity

  • The Entity field contains information about which domain or entity the alert belongs to. The entity can be an application, a server, or any other identifying information for the domain.

Source

  • In the Source field, you can specify an origin for the alert. The default value for Source is the IP address where the alert originated.

Priority

The Priority indicates the urgency level of the alert. The default level in OpsGenie is P3.

  • P1 - Critical

  • P2 - High

  • P3 - Moderate

  • P4 - Low

  • P5 - Information

User

  • The User field defines the owner of the OpsGenie Note attached to the alert. Copy User Names or User ID's from the OpsGenie Integration Users (IDs) view in OpsGenie.

Note

  • In the Note field, you can add information that will be added to the alert when it is created.

Once you are done, make sure you save your entries by Adding the OpsGenie Webhook Target

  • Click the Add WebHook OpsGenie Target button

  • Target is created, containing the selected user/targets.

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*.

  • No labels

Can't find what you're looking for? Send an E-mail to support@apica.io