Ingesting alerts from third-party tools into OpManager

In complex enterprise environments, IT teams often rely on multiple monitoring tools to manage different systems: servers, networks, applications, and more. OpManager supports ingesting alerts from these third-party tools through multiple flexible and standardized methods. Integrating third-party events into OpManager allows you to consolidate event data and gain centralized visibility across your IT environment, regardless of the source.

This document explains the supported methods and provides detailed steps to help you set up event ingestion.

REST API

OpManager provides versatile REST APIs and webhooks that allow third-party tools to push alerts directly into its monitoring system. By ingesting events via API, organizations can centralize alerts from across their IT infrastructure, enabling a unified view of network health and quicker incident response.

The addEvent API allows third-party applications to send event data directly to OpManager using their native REST API or webhook capabilities.

Endpoint:api/json/events/addEvent

Method: POST

Supported formats: Form data, query parameters

Authentication: API key

Using form data

You can send event data to OpManager by making a POST request with form-encoded data. This method is ideal for tools that support submitting data as application/x-www-form-urlencoded.

POST https://<OpManager_Server>:8060/api/json/events/addEvent
Headers: Content-Type: application/x-www-form-urlencoded
Form data: source=Test_Device_MoName severity=1 message=Sample_Critical_Message alarmCode=Sample_AlarmCode entity=Sample_Entity eventType=Sample_EventType apiKey=***

Using query parameters

POST https://<OpManager_Server>:8060/api/json/events/addEvent?source=Test_Device_MoName&severity=1&message=Sample_Critical_Message&alarmCode=Sample_AlarmCode&entity=Sample_Entity&eventType=Sample_EventType&apiKey=***

To ingest alerts from Cisco Meraki devices using JSON payloads, refer to this document.

Using custom scripts

You can create custom scripts to automatically forward events from third-party tools to OpManager as alerts. The following are example scripts for sending alerts to OpManager.

Example: PowerShell (Windows)

# Define form data as a hashtable
$formData = @{
apiKey     = "***"
source     = "Windows_Server"
severity   = "1"
message    = "Disk space low"
alarmCode  = "Disk_Space_Alert"
entity     = "Server_XYZ"
eventType  = "Performance_Alert"
}

# Send form-encoded POST request
Invoke-RestMethod -Uri "https://<OpManager_Server>:8060/api/json/events/addEvent" `
-Method Post `
-Body $formData `
-ContentType "application/x-www-form-urlencoded"

Example: Bash (Linux)

# OpManager server details
OPMANAGER_HOST="https://<OpManager_Server>:8060"
API_ENDPOINT="/api/json/events/addEvent"

# API key
API_KEY="your_api_key_here"

# Send form data payload
curl -k -X POST "${OPMANAGER_HOST}${API_ENDPOINT}" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data "apiKey=${API_KEY}" \
--data "source=Windows_Server" \
--data "severity=1" \
--data "message=Disk space low" \
--data "alarmCode=Disk_Space_Alert" \
--data "entity=Server_XYZ" \
--data "eventType=Performance_Alert"

Integrating with ManageEngine Applications Manager using Webhook/REST API

Applications Manager (APM) monitors applications, application servers, and databases, while OpManager monitors networks and infrastructure. When used separately, IT teams have to switch between consoles to determine whether an application issue is caused by an underlying server or network problem, making troubleshooting and root cause analysis slower.

Integrating Applications Manager with OpManager using Webhook/REST API lets you forward APM alarms into OpManager as events, bringing application-level and infrastructure-level alerts together in a single console. This gives IT teams unified, end-to-end visibility across the stack and helps them correlate issues and respond to incidents faster.

Pre-requisites

  • The server must be added in both OpManager and Applications Manager (APM) using the same IP address / DNS name.
  • The OpManager server must be reachable from the APM server.

Configuration Plan

  • In APM, configure a Webhook/REST API action to invoke OpManager's addEvent API whenever an alarm is triggered. Pass the server's IP address ($HOSTIP) as the source parameter.