'Create Alarm' request.
Create Alarm request is a request used to create alarms in AlarmsOne. To send your application alarms to AlarmsOne, set your data in Body Params as form-data and send a HTTP POST request to the webhook URL obtained.
Sample webhook URL:
https://plusalarmsone.manageengine.com/CustomAlarmCollector?authtoken=3d31bcd5bf1e3007b0c7dbcf97514&appkey=7075e34cf4018f32022e323052288
A Create Alarm request takes the following parameters.
| Key Name | Description | Value Type & Limit | Field requirement |
|---|---|---|---|
| entity_id | It is your Alarm ID/Profile ID for the event triggered. | String value. Up to 200 characters. | Optional |
short_message | It is a short description of the event triggered. This field is the Display Name of an Alarm shown in AlarmsOne. |
String value. Up to 1000 characters. |
Mandatory |
entity_name | It indicates the entity from which an event is triggered. Entity name can be a machine name, IP address, website, or any other entity. |
String value. Up to 300 characters. |
Optional |
category | This field indicates the category to which the triggered event belongs to. For example, it can be server monitoring, app monitoring, or any kind of category to which the event belongs to. |
String value. Up to 200 characters. |
Optional |
| message | This field contains a detailed explanation of the event, which caused the incident to occur. | String value. Up to 3000 characters. | Optional |
| event_time | This field shows the time at which the event is triggered. | Long. In milliseconds. | Optional |
severity | This field reveals the severity of the alert. Severity can be critical, major, warning, or clear. [case sensitive] | critical, major, warning, or clear. If an event doesn't contain this key name, severity will be mapped as warning, by default. |
Optional |
payload |
This field value should be a JSONObject that can contain any customized field you need. | JSONObject. JSONObject key. Up to 1000 characters. |
Optional |
Response:
Once you send a POST request, you will get a response. The response is a JSON object with key "alarmid" and an array of String as its value.
You can use this 'alarmid' to further work on that alert through API calls. Please click here to view the APIs for the actions you can perform.
Sample response:
{
"alarmid": [
"17479_205006"
]
}
Sample:
URL : https://plusalarmsone.manageengine.com/CustomAlarm?zapikey=XXXX&appkey=YYYY
Method : POST
Data :
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
OR
URL : https://plusalarmsone.manageengine.com/CustomAlarm?zapikey=XXXX&appkey=YYYY
Method : POST
Data :
short_message:iOS version update failed
payload:{"testkey":"testval","Request Type":"EVENTNOTIFICATION","Site":"NET1004","Subcategory":"VV","Item":"Panel","Device":"Keypad"}