Alerts

An alert represents something to watch for in the system. Currently there are 7 different alerts defined:

• Flame Guard Alarm: This alert type indicates that the flame guard alarm in a booth was activated 5 or more times within 5 days.
• Exhaust Filter Warning: This alert type indicates that the exhaust filter's usage is at 80% of its recommended life.
• Exhaust Filter Limit Reached: This alert type indicates that the exhaust filter has reached its max recommended usage hours.
• Exhaust Motor Trip: This alert type indicates that the exhaust motor has tripped 3 or more times in the last 20 starts.
• Intake Filter Warning: This alert type indicates that the intake filter's usage is at 80% of its recommended life.
• Intake Filter Limit Reached: This alert type indicates that the intake filter has reached its max recommended usage hours.
• Intake Motor Trip: This alert type indicates that the intake motor has tripped 3 or more times in the last 20 starts.

The Alert Object

An alert returned by the API may have the following fields:

• id: "The id of the alert itself"
• triggered_at: "ISO8601 encoded timestamp"
• type: "The type of alarm. This can be one of the types described above"
• type_id: "The id of the type of the alert"
• active: "Whether the alarm is currently active or not"
• booth_id: "The id of the booth"
• booth_name: "The name of the booth where the alert happened"
• facility_id: "The id of the facility where the alert happened"
• facility_name: "The name of the facility where the alert happened"

And this is what an example of an alert could look like:

{
  "id": "1ee815a1-e79b-4e01-86bf-d48baea8ef50",
  "triggered_at": "2024-07-31 03:08:00Z",
  "type": "Flame Guard Alarm",
  "type_id": "000df69f-014c-4e7a-9fb6-2bf82b52d4af",
  "active": false,
  "booth_id": "812bf68c-018a-9f8c-acc8-23142b52d8ba",
  "booth_name": "My test booth",
  "facility_id": "123df68f-014c-4e7a-9fb6-1ff82b52daca",
  "facility_name": "My test facility"
}