Machine Readable Alerts
Checkit Alerts can be sent in a machine-readable format so your technical staff can integrate our alert data into your in-house/third-party systems. Details of this useful feature are included below. This is an optional feature not available by default so if you want to use it, please contact us by email at help@checkit.net.
Monitored Inbox
Monitored inbox is a feature that sends all Checkit Alert notifications via JSON-formatted emails. Notifications are sent on the creation of new alert message for all types of alert generated by our Workflow Management service (checks and checklists, the App and Probe):
Check Report
Job Cancelled
Job Overdue
Notifications are sent on the creation of new alert message for all types of alert generated by our Automated Monitoring service (sensors, hubs etc.) :
Sensor Alert
Sensor Battery Alert
Sensor Miscom Alert
Hub Miscom Alert
JSON data is supplied as text in the body of the email.
Note: the current release does not support updates to alerts, only new alerts.
Configuration
The feature is configured by adding an email address to receive monitored inbox messages. This can be performed via a request to customer services at help@checkit.net.
Message Schema
This section provides an overview of the fields provided in the JSON messages.
Note: A JSON Schema can be supplied upon request to provide a machine consumable specification.
Note: All dates are specified as UTC ISO 8601 strings
The specification of the alert is provided in Typescript Format.
For those not familiar with TypeScript the "?" operator indicates that a field is optional and the "|" operator indicates the the field may contain one of the stated values.
The key field for parsing messages is the "type" field as this determines which of the subsequent fields will be included or omitted.
Primary Fields
The following top-level fields are common to all messages for both our Workflow Management and Automated Monitoring services.
Field | Description |
|---|---|
code | The unique identifier of the alert |
category | Indicates if the alert originates from a sensor, a check, or a service alert (Low battery etc) |
type | Indicates the type of the alert. Each type will be described in detail in a subsequent section |
whenRaised | ISO UTC Date indicating the time the alert was raised |
status | The current status of the alert (Note: only active alerts are currently supported notification of acknowledged and cleared alerts will be added in a later release ) |
canClear | If the alert can be cleared via the Control Centre |
teamName | The name of the team associated with the device |
location | The name and unique identifier of the location the alert originated from |
what | An array containing "what" the alert resulted from. Full details of the DeviceJSON object are in a subsequent section |
sensorDetails | The details of the sensor. Only applicable to sensor alerts. Full details of this object are in a subsequent section |
checkDetails | The details of the check that resulted in the alert being raised. This is only applicable to Check related alerts. (Types: 'check' | 'overdue' | 'cancellation') |
DeviceJSON
This field is contained within the message.
Field | Description |
|---|---|
deviceCategory | The category of the device causing the alert |
deviceType | The subtype of the device (only applicable for sensors) |
deviceId | The unique identifier for the device |
deviceName | The human readable display name for the sensor |
deviceDescription | Any description string associated with the device |
SensorDetails
The following fields are specific to alerts originating from a sensor (Automated Monitoring service only).
Field | Description |
|---|---|
ruleName | The name of the rule that was breached resulting in the alert being raised |
input | The input that caused the alert to be raised. For a temperature sensor this will be the temperature, for a contact sensor it will be the open, close status |
CheckDetails
The following fields relate to checks/checklists and as such are present on "check", "overdue" and "cancellation" messages only (Workflow Management service).
Field | Description |
|---|---|
checkName | The name of the check that caused the alert |
checklistName | The name of the check list that caused the alert |
checkpointName | The checkpoint associated with the alert |
cancellationReason | The user input reason for cancellation. Cancellation messages only |
checkType | The type of the check input: "temperature", "date", or "text" |
checkValue | The user input as part of the check |
Alert Types
Check Report
Type: "check"
This alert type occurs when a user action in a check results in an alert being raised. (Workflow Management service).
The checkDetails object will be set with the fields: "checklistName", "checkName", "checkpointName", "checkType" and "checkValue" populated
Job Cancelled
Type: 'cancelled'
This alert occurs when a user cancels a job (Workflow Management service).
The checkDetails object will be set with the fields: "checkName", "checkpointName", "cancellationReason" populated.
Job Overdue
Type: 'overdue'
This alert occurs when a job (completion of a check/checklist) becomes overdue (Workflow Management service).
The checkDetails object will be set with the fields: "checkName", "checkpointName" populated.
Sensor Alert
Type: 'sensor'
This alert occurs when a sensor reading breaches a configured rule (Automated Monitoring service).
The sensorDetails object will be set.
Sensor Battery Alert (Service Alert)
Type: 'lowBattery'
This alert occurs when a sensor requires a battery change (Automated Monitoring service).
Sensor Miscom Alert (Service Alert)
Type: 'sensorMiscom'
This alert occurs if a sensor fails to communicate for a configured period (Automated Monitoring service).
Hub Miscom Alert (Service Alert)
Type: 'hubMiscom'
This alert occurs if a Checkit hub fails to communicate for a configured period (Automated Monitoring service).