Alert Format

This document describes the alert webhook format used by the Viziosense integrator platform.

Alert message structure

Alert messages use the same top-level fields as other webhook payloads, with an alert field containing one or more alert objects.

FIRING example

{
  "version": 1,
  "stream_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "VCW",
  "timestamp": 1706154946,
  "alert": [
    {
      "uuid": "d4a8a7c3-3d1e-4d1f-a4bc-567e34a7938a",
      "rule_summary": {
        "rule": "GREATER_THAN",
        "trigger_value": 100,
        "clearing_value": 90
      },
      "deviceUuid": "123e4567-e89b-12d3-a456-426614174000",
      "app_type": "VCW",
      "actual_value": 112,
      "timestamp": 1706154946,
      "type": "FIRING",
      "state": "LIMIT_REACHED",
      "reference_marker": {
        "uuid": "b2f1c127-1eca-4b71-878b-5d7dc6f3c095",
        "name": "Zone-name"
      }
    }
  ]
}

CLEARING example

{
  "version": 1,
  "stream_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "VCW",
  "timestamp": 1706154946,
  "alert": [
    {
      "uuid": "e8b0d045-9d3b-4f87-988d-2a1b1c3c9f24",
      "rule_summary": {
        "rule": "LESS_THAN",
        "trigger_value": 100,
        "clearing_value": 90
      },
      "deviceUuid": "123e4567-e89b-12d3-a456-426614174000",
      "app_type": "VCW",
      "actual_value": 85,
      "timestamp": 1706154946,
      "type": "CLEARING",
      "state": "LIMIT_CLEARED",
      "reference_marker": {
        "uuid": "b2f1c127-1eca-4b71-878b-5d7dc6f3c095",
        "name": "Zone-name"
      },
      "previous_uuid": "d4a8a7c3-3d1e-4d1f-a4bc-567e34a7938a"
    }
  ]
}

Top-level fields

• version: The application version. Default is 1; if omitted, assume version 0.
• stream_id: Device UUID.
• type: Application type code. Supported values are VCW, VPM, VCB, VCZ, and VYD.
• timestamp: Alert message timestamp in UNIX time format (UTC).
• alert: The application-specific alert array. It must contain at least one alert object.

Alert object fields

Every object in the alert array contains the following required fields:

• uuid: Unique alert identifier.
• rule_summary: The rule that triggered or cleared the alert.
  • rule: GREATER_THAN or LESS_THAN.
  • trigger_value: Value that triggered the alert.
  • clearing_value: Value that cleared the alert.
• deviceUuid: UUID of the device that generated the alert.
• app_type: Application type code for the alert object. Supported values are VCW, VPM, VCB, VCZ, and VYD.
• actual_value: Actual value measured by the alert.
• timestamp: Alert timestamp in UNIX time format (UTC).
• type: FIRING or CLEARING.
• state: The alert state.
  • For FIRING: LIMIT_REACHED or ANOMALY.
  • For CLEARING: LIMIT_CLEARED or NORMAL.
• reference_marker: Reference marker that generated the alert.
  • uuid: Marker UUID.
  • name: Marker name.
• previous_uuid: Present only for CLEARING; UUID of the previous alert that is cleared.

Alert states

• FIRING: An alert has been raised.
• CLEARING: The alert has been cleared.

Schema reference

The complete alert schema is shown below:

Loading ....