Inbound applications added via Custom API Integration can send alerts to ServiceDesk Plus Cloud via webhook only.
To send alarms, set the data in Body Params as form-data and send a HTTP POST request to the webhook URL. You can obtain the webhook URL from the Inbound Applications list view.
Sample Webhook URL:
You can use the following keys as Body Params:
|
Key Name |
Description |
Value Type |
Limit |
Field Requirement |
|
entity_id |
Alert ID/Profile ID of the triggered alert. |
String |
200 characters |
Optional |
|
short_message |
Brief description of the triggered alert. |
String |
1,000 characters |
Mandatory |
|
entity_name |
The entity from which the alert is triggered. The entity_name can be a machine name, IP address, website, or any such entities. |
String |
300 characters |
Optional |
|
category |
Category of the triggered alert. For example, it can be server monitoring, app monitoring, etc. |
String |
200 characters |
Optional |
|
message |
Detailed explanation of how the alert occurred. |
String |
3,000 characters |
Optional |
|
event_time |
The time of the alert trigger. |
Long |
Value in milliseconds |
Optional |
|
severity |
Severity of the alert. It can be critical, major, warning, or clear. |
String |
[case sensitive] critical, major, warning, or clear. If the Body Param does not contain this key, severity will be set as warning by default. |
Optional |
|
payload |
JSONObject that contain any customized field. |
JSONObject key: Alphanumeric Value. |
1,000 characters. JSON Object size: Up to six fields. |
Optional |
Sample Input Data and Response:
|
Webhook URL |
Method |
Input Data |
Response |
|
https://plusalarmsone.manageengine.com/CustomAlarm?zapikey=XXXX&appkey=YYYY |
POST |
entity_id:21222243 short_message:android version update failed entity_name:local machines category:server message:CPU % exceeded the threshold 90% Restarting the machine. severity:critical |
{ |
|
https://plusalarmsone.manageengine.com/CustomAlarm?zapikey=XXXX&appkey=YYYY |
POST |
short_message:iOS version update failed payload:{"testkey":"testval","Request Type":"EVENTNOTIFICATION","Site":"NET1004","Subcategory":"VV","Item":"Panel","Device":"Keypad"} |
{ |