Event Object
The Event Object in the API represents an Incident in Garmingo Status.
This is equal to the Event from the "Incidents" Tab and "Monitors" Tab in the Dashboard.
Properties
The Event Object has the following properties:
Property | Type | Description | Required |
---|---|---|---|
id | string | The unique identifier of the Event. | Yes |
monitorId | string | The Monitor ID that triggered the Event. | Yes |
status | boolean | The status of the Event. (Up/Down) | Yes |
timestamp | Date | When the Event was triggered. | Yes |
metadata | object | Additional metadata of the Event. | Yes |
Example
{
"id": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
"monitorId": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
"status": true,
"timestamp": "2021-01-01T00:00:00.000Z",
"metadata": {
"key": "value"
}
}