Monitoring system

How It Works

Alerts sent via email or webhooks are notifications dispatched according to a chosen frequency. Synchronizations must be configured through the data type sync settings to enable the completion of the events defined in the alert.
The synchronization frequency must align with the alert frequency to ensure proper functionality.
Learn more about sync settings here.

When an event is configured and triggered, a summary email is sent based on the email frequency. The email includes a section for each user.

Once alerts are defined based on the selected events and sync settings are configured accordingly, users can be assigned to alerts.

Key Steps:

1. Alert creation must be coordinated with a Qard staff member.

2. A list of configured alerts can be retrieved using the endpoint:
   GET /api/v6/notification

   Example response:

   ["notif_name_1", "notif_name_2"]

3. To assign a user to an alert, use the following endpoint:
   PATCH /api/v6/users/{userId}

   Example request body:

   {
     "name": "string",
     "group": "default",
     "notifications": []
   }

   Add the name of the configured alert to the notifications field to associate the user with the alert.

---

Webhook Structure

Webhook payloads follow the structure below:

{
  "events": {
    "add": [
      {
        "data_type": "string",
        "data": ["entity_uuid"]
      }
    ],
    "remove": [
      {
        "data_type": "string",
        "data": ["entity_uuid"]
      }
    ],
    "update": [
      {
        "data_type": "string",
        "changes": {
          "entity_uuid": "string",
          "data": {}
        }
      }
    ]
  }
}