OpManager Integration Guide
ManageEngine OpManager is a network monitoring application. It allows all types of network devices like routers, switches, VMs, firewalls and more to be monitored all from one place. TaskCall integrates with OpManager to increase the visibility of alarms raised by the application to reduce the time to response and resolution of network issues.
Pointers
- The integration is between a TaskCall service and ManageEngine OpManager.
- This integration only receives alerts in TaskCall from ManageEngine.
- Incidents will automatically resolve in TaskCall when the corresponding alarm clears.
In TaskCall
- Go to Configurations > Integrations and click New Integration.
- Select the ManageEngine OpManager integration.
- Give the integration a name and configure how incidents will be created. Only the Default Service field is required. The rest are optional.
- Incidents (Optional)
- TaskCall automatically maps incoming payloads with internal attributes to create incidents. However, this can be customized in the Incidents tab. Constant values can be included alongside placeholders to dictate which attributes should map to the Incident Title, Description, Tags, Snapshots and Vendor URL. To insert a placeholder use double curly braces.
For example, if you enter {{ alert.title }} in the Incident Title field, TaskCall will look for an attribute called "title" nested inside another attribute called "alert" in the incoming payload. If the nested attribute exists, its corresponding value will be pulled from the payload and inserted. If the nested attribute does not resolve successfully, TaskCall will fall back to the default mapping.
If you are unsure, please leave the fields empty. TaskCall will use the default mapping to create the incident for you. - Select the Urgency level the incident should be created at.
- Select the option to Group similar alerts together if you would like follow up triggers from the same alert source to be grouped into the same incident. If you leave this option unchecked, then a new incident will be created for every trigger. (This behavior is specific to new triggers; not updates to an alert.)
- Click Next to move on to the Services tab.
- TaskCall automatically maps incoming payloads with internal attributes to create incidents. However, this can be customized in the Incidents tab. Constant values can be included alongside placeholders to dictate which attributes should map to the Incident Title, Description, Tags, Snapshots and Vendor URL. To insert a placeholder use double curly braces.
- Services (Required)
- Select the Default Service incidents should be sent to. To route incidents to different services instead, set Map With Attribute to the attribute to route by using a placeholder. Then, map each value it can take to the service that should receive it.
For example, to route by a region attribute sent in the payload, set Map With Attribute to {{ region }}, then map US to one service and EU to another, and so on.
- Click Next to move on to the Authorization tab.
- Select the Default Service incidents should be sent to. To route incidents to different services instead, set Map With Attribute to the attribute to route by using a placeholder. Then, map each value it can take to the service that should receive it.
- Authorization (Optional)
- The Authorization tab allows a Bearer Token and an IP Allowlist be added if you would like to restrict who is able to send alerts to this integration. If you are unsure, this can be skipped.
- Once done, click Save.
- Copy the Integration Url that is issued for the integration. This will be used to set up the notification in ManageEngine OpManager.
In ManageEngine OpManager
- Go to Settings > Notifications > Add Profile.
- Select Invoke a Webhook.
- Set the Hook URL to POST and paste the Integration Url you copied over from TaskCall.
- Set Data Type to raw.
- Set Payload Type to JSON.
- Set the Body Content to the payload you want to be sent. You can customize the payload as you want, but in order to group alerts, amend urgency and resolve incidents automatically please refer to ManageEngine Body Content.
- Run Test Action and make sure a test incident is created. If the test runs successfully and an incident is created in TaskCall, then click Next.
- Choose on what events alarms should be sent for this notification profile. If you want the incident to resolve automatically, then make sure you choose the option to Notify when the alarm is cleared. Click Next.
- Choose the Devices and URLs this notification profile should run for. Define the time windows. In the last step, give the profile a name; preferably TaskCall.
- Click Save when you are done. That's it!
OpManager Body Content
You can enter any payload you want for the webhook body content. However, if you want the full functionality of the integration, then please include the following fields:
{
"alarmid": "$alarmid",
"message": "$message",
"displayName": "$displayName",
"stringseverity": "$stringseverity",
"eventType": "$eventType"
}
"alarmid": "$alarmid",
"message": "$message",
"displayName": "$displayName",
"stringseverity": "$stringseverity",
"eventType": "$eventType"
}