For the complete documentation index, see llms.txt. This page is also available as Markdown.

Welche Standard-Templates für Webhook-Payloads gibt es bei Enginsight Alarmen?

Webhooks bieten dir die Möglichkeit, Alarme mit Drittanbieter-Anwendungen zu verknüpfen, um Benachrichtigungen auch außerhalb der Enginsight Plattform, z.B. in einem Messenger oder externen Ticketsystem, erhalten zu können.

Dabei sendet Enginsight eine HTTP-Anfrage (typischerweise POST) an die angegebene Webhook-URL und übermittelt darin einen Payload, also einen spezifischen Inhalt, im JSON-Format.

lightbulb-exclamation

Standard-Templates für Payloads

Abhängig von der Art des Alarms, dem ein Webhook zugeordnet wurde, gibt es zwei Standard-JSON-Templates für den Webhook-Payload: eines für metrikbasierte Alarme und eines für szenariobasierte Alarme.

lightbulb-exclamation

Payload-Template für Webhooks bei metrikbasierten Alarmen

Ein Standard-Payload für Webhooks bei metrikbasierten Alarmen sieht wie folgt aus:

{
    "resolved": ...,
    "belongsTo": "...",
    "alert": {
        "name": "...",
        "_id": "...",
        "description": "..."
    },
    "organisationId": "...",
    "organisationName": "...",
    "property": {
        "result": ...,
        "expected": ...,
        "operator": "...",
        "aggregator": "...",
        "name": "..."
    },
    "reference": {
        "hostname": "...",
        "_id": "..."
    }
}
Parameter
Beschreibung

resolved

Gibt den Status des Alarms an:

  • false: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, ist noch nicht behoben.

  • true: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, wurde behoben.

belongsTo

Gibt die Art des Objekts an, für das der Alarm gilt, z.B. host oder endpoint.

alert

Gibt Informationen zum Alarm an:

  • name: Zeigt den Namen des Alarms.

  • _id: Zeigt die eindeutige Kennung des Alarms.

  • description: Zeigt die benutzerdefinierte Beschreibung des Alarms, falls angegeben.

organisationID

Gibt die eindeutige Kennung der Organisation an, die der Alarm betrifft.

organisationName

Gibt den Namen der Organisation an, die der Alarm betrifft.

property

Gibt Informationen zur Metrik an, die den Alarm ausgelöst hat:

  • result: Zeigt den tatsächlich gemessenen Wert.

  • expected: Zeigt den erwarteten Grenzwert.

  • operator: Zeigt den Operator, der für den Grenzwert gilt.

    • gt: greater than (größer als)

    • lt: lower than (kleiner als)

    • eq: equals (gleich)

  • aggregator: Zeigt den Aggregator, wie pro Messpunkt gemessene Werte zusammengefasst und angezeigt werden.

    • avg: Durchschnittswert

    • min: Minimalwert

    • max: Maximalwert

  • name: Zeigt den internen Namen der überwachten Metrik.

reference

Gibt Informationen zum Objekt an, für das der Alarm gilt.

  • hostname: Zeigt den Namen des Objekts.

  • _id: Zeigt die eindeutige Kennung des Objekts.

Payload-Template für Webhooks bei szenariobasierten Alarmen

Ein Standard-Payload für Webhooks bei szenariobasierten Alarmen sieht wie folgt aus:

Parameter
Beschreibung

resolved

Gibt den Status des Alarms an:

  • false: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, ist noch nicht behoben.

  • true: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, wurde behoben.

belongsTo

Gibt die Art des Objekts an, für das der Alarm gilt, z.B. host oder endpoint.

alert

Gibt Informationen zum Alarm an:

  • name: Zeigt den Namen des Alarms.

  • _id: Zeigt die eindeutige Kennung des Alarms.

  • description: Zeigt die benutzerdefinierte Beschreibung des Alarms, falls angegeben.

organisationID

Gibt die eindeutige Kennung der Organisation an, die der Alarm betrifft.

organisationName

Gibt den Namen der Organisation an, die der Alarm betrifft.

scenario

Gibt Informationen zum Szenario an, das den Alarm ausgelöst hat:

  • name: Zeigt den Namen bzw. die Art des Szenarios.

  • payload: Zeigt weitere Details zu Werten, die den Alarm ausgelöst haben, als Key-Value-Paare, z.B. letze Verfügbarkeit einer Webseite.

reference

Gibt Informationen zum Objekt an, für das der Alarm gilt.

  • hostname: Zeigt den Namen des Objekts.

  • _id: Zeigt die eindeutige Kennung des Objekts.


Benutzerdefinierte Payloads

Wenn du keines der Standard-Templates verwenden möchtest, hast du auch die Möglichkeit, einen benutzerdefinierten Payload anzugeben, in dem du dynamische Platzhalter verwenden kannst.

lightbulb-exclamation

Zuletzt aktualisiert

War das hilfreich?