Incident Management

Overview

The Xyte platform tracks three types of Incidents on a Device:

  1. Rule-based — created automatically when a Rule matches Device Telemetry. See Incident Rules.
  2. End Customer — opened manually by an End User in the Customer Portal.
  3. Device-initiated — opened by the Device itself via the Open Incident API.

Device-initiated incidents

Use Device-initiated Incidents to surface internal errors or warning states the Device detects locally. Reporting these to the server gives the End Customer a clearer picture of the Device's health than Telemetry alone.


The following APIs are available:

  1. Open Incident — open a new Incident on the Device.
  2. Close Incident — close an End Customer or Device-initiated Incident.
  3. Get Incidents — list the open Incidents on a Device.
  4. Close Incidents — clear all Device-initiated Incidents after a reboot or re-registration.