Format des alertes

Ce document décrit le format des webhooks d'alerte utilisés par la plateforme intégrateur Viziosense.

Structure du message d'alerte

Les messages d'alerte utilisent les mêmes champs de niveau supérieur que les autres payloads, avec un champ alert contenant une ou plusieurs alertes.

Exemple FIRING

{
  "version": 1,
  "stream_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "VCW",
  "timestamp": 1706154946,
  "message_timestamp": 1706154946,
  "alert": [
    {
      "uuid": "d4a8a7c3-3d1e-4d1f-a4bc-567e34a7938a",
      "message_timestamp": 1706154946,
      "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"
      }
    }
  ]
}

Exemple CLEARING

{
  "version": 1,
  "stream_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "VCW",
  "timestamp": 1706154946,
  "message_timestamp": 1706154946,
  "alert": [
    {
      "uuid": "e8b0d045-9d3b-4f87-988d-2a1b1c3c9f24",
      "message_timestamp": 1706154946,
      "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"
    }
  ]
}

Champs de niveau supérieur

• version: Version de l’application. Par défaut 1; si omis, considérer comme 0.
• stream_id: UUID du device.
• type: Code du type d’application. Valeurs supportées : VCW, VPM, VCB, VCZ, et VYD.
• timestamp: Timestamp du message d’alerte au format UNIX (UTC).
• message_timestamp: Timestamp optionnel du message d’alerte au format UNIX (UTC).
• alert: Tableau d’alertes spécifiques à l’application. Il doit contenir au moins une alerte.

Champs de l’objet alerte

Chaque objet du tableau alert contient les champs suivants :

• uuid: Identifiant unique de l'alerte.
• rule_summary: Résumé de la règle qui a déclenché ou effacé l’alerte.
  • rule: GREATER_THAN ou LESS_THAN.
  • trigger_value: Valeur qui a déclenché l’alerte.
  • clearing_value: Valeur qui a effacé l’alerte.
• deviceUuid: UUID de l’appareil qui a généré l’alerte.
• app_type: Code du type d’application pour l’alerte. Valeurs supportées : VCW, VPM, VCB, VCZ et VYD.
• message_timestamp: Timestamp de cet objet d’alerte au format UNIX (UTC).
• actual_value: Valeur mesurée qui a déclenché l’alerte.
• timestamp: Timestamp de l’alerte au format UNIX (UTC).
• type: FIRING ou CLEARING.
• state: État de l’alerte.
  • Pour FIRING : LIMIT_REACHED ou ANOMALY.
  • Pour CLEARING : LIMIT_CLEARED ou NORMAL.
• reference_marker: Marqueur de référence à l’origine de l’alerte.
  • uuid: UUID du marqueur.
  • name: Nom du marqueur.
• previous_uuid: Présent uniquement pour CLEARING ; UUID de l’alerte précédente qui est effacée.

États des alertes

• FIRING : Une alerte a été déclenchée.
• CLEARING : L’alerte a été effacée.

Référence du schéma

Le schéma complet des alertes est affiché ci-dessous :

Loading ....