> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/knowledge-base/alarme/welche-standard-templates-fur-webhook-payloads-gibt-es-bei-enginsight-alarmen.md).

# 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.

{% hint style="success" icon="lightbulb-exclamation" %}
Mehr Informationen, wie du in der Enginsight Plattform einen Webhook erstellst, findest du im Enginsight Handbuch: [Webhook hinzufügen](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme-beta/webhooks-beta/webhook-hinzufugen-beta). 
{% endhint %}

***

## 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](#payload-template-fur-webhooks-bei-metrikbasierten-alarmen) und eines für [szenariobasierte Alarme](#payload-template-fur-webhooks-bei-szenariobasierten-alarmen).

{% hint style="success" icon="lightbulb-exclamation" %}
Mehr Informationen, wie du in der Enginsight Plattform einen Alarm erstellst, findest du im Enginsight Handbuch: [Alarm hinzufügen](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme-beta/ubersicht-beta/alarm-hinzufugen-beta). Mehr Informationen zu verfügbaren Alarmen findest du in der Knowledge Base: [Welche spezifischen Alarme kann ich in Enginsight definieren?](/docs/knowledge-base/alarme/welche-spezifischen-alarme-kann-ich-in-enginsight-definieren.md)
{% endhint %}

### 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": "..."
    }
}
```

<table><thead><tr><th width="248.921875">Parameter</th><th>Beschreibung</th></tr></thead><tbody><tr><td><code>resolved</code></td><td><p>Gibt den Status des Alarms an:</p><ul><li><code>false</code>: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, ist noch nicht behoben.</li><li><code>true</code>: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, wurde behoben.</li></ul></td></tr><tr><td><code>belongsTo</code></td><td>Gibt die Art des Objekts an, für das der Alarm gilt, z.B. <code>host</code> oder <code>endpoint</code>.</td></tr><tr><td><code>alert</code></td><td><p>Gibt Informationen zum Alarm an:</p><ul><li><code>name</code>: Zeigt den Namen des Alarms.</li><li><code>_id</code>: Zeigt die eindeutige Kennung des Alarms.</li><li><code>description</code>: Zeigt die benutzerdefinierte Beschreibung des Alarms, falls angegeben.</li></ul></td></tr><tr><td><code>organisationID</code></td><td>Gibt die eindeutige Kennung der Organisation an, die der Alarm betrifft.</td></tr><tr><td><code>organisationName</code></td><td>Gibt den Namen der Organisation an, die der Alarm betrifft.</td></tr><tr><td><code>property</code></td><td><p>Gibt Informationen zur Metrik an, die den Alarm ausgelöst hat:</p><ul><li><code>result</code>: Zeigt den tatsächlich gemessenen Wert.</li><li><code>expected</code>: Zeigt den erwarteten Grenzwert.</li><li><p><code>operator</code>: Zeigt den Operator, der für den Grenzwert gilt.</p><ul><li><code>gt</code>: greater than (größer als)</li><li><code>lt</code>: lower than (kleiner als)</li><li><code>eq</code>: equals (gleich)</li></ul></li><li><p><code>aggregator</code>: Zeigt den Aggregator, wie pro Messpunkt gemessene Werte zusammengefasst und angezeigt werden.</p><ul><li><code>avg</code>: Durchschnittswert</li><li><code>min</code>: Minimalwert</li><li><code>max</code>: Maximalwert</li></ul></li><li><code>name</code>: Zeigt den internen Namen der überwachten Metrik.</li></ul></td></tr><tr><td><code>reference</code></td><td><p>Gibt Informationen zum Objekt an, für das der Alarm gilt.</p><ul><li><code>hostname</code>: Zeigt den Namen des Objekts.</li><li><code>_id</code>: Zeigt die eindeutige Kennung des Objekts.</li></ul></td></tr></tbody></table>

### Payload-Template für Webhooks bei szenariobasierten Alarmen

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

```
{
    "resolved": ...,
    "belongsTo": "...",
    "alert": {
        "name": "...",
        "_id": "...",
        "description": "..."
    },
    "organisationId": "...",
    "organisationName": "...",
    "scenario": {
        "name": ...,
        "payload": [
        { "key": "scenario", "value": "..." },
        { "key": "...", "value": "..." }
        ]
    },
    "reference": {
        "hostname": "...",
        "_id": "..."
    }
}
```

<table><thead><tr><th width="248.921875">Parameter</th><th>Beschreibung</th></tr></thead><tbody><tr><td><code>resolved</code></td><td><p>Gibt den Status des Alarms an:</p><ul><li><code>false</code>: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, ist noch nicht behoben.</li><li><code>true</code>: Das Vorkommnis (Auffälligkeit / Issue oder Vorfall / Incident), das durch den Alarm ausgelöst wurde, wurde behoben.</li></ul></td></tr><tr><td><code>belongsTo</code></td><td>Gibt die Art des Objekts an, für das der Alarm gilt, z.B. <code>host</code> oder <code>endpoint</code>.</td></tr><tr><td><code>alert</code></td><td><p>Gibt Informationen zum Alarm an:</p><ul><li><code>name</code>: Zeigt den Namen des Alarms.</li><li><code>_id</code>: Zeigt die eindeutige Kennung des Alarms.</li><li><code>description</code>: Zeigt die benutzerdefinierte Beschreibung des Alarms, falls angegeben.</li></ul></td></tr><tr><td><code>organisationID</code></td><td>Gibt die eindeutige Kennung der Organisation an, die der Alarm betrifft.</td></tr><tr><td><code>organisationName</code></td><td>Gibt den Namen der Organisation an, die der Alarm betrifft.</td></tr><tr><td><code>scenario</code></td><td><p>Gibt Informationen zum Szenario an, das den Alarm ausgelöst hat:</p><ul><li><code>name</code>: Zeigt den Namen bzw. die Art des Szenarios.</li><li><code>payload</code>: Zeigt weitere Details zu Werten, die den Alarm ausgelöst haben, als Key-Value-Paare, z.B. letze Verfügbarkeit einer Webseite.</li></ul></td></tr><tr><td><code>reference</code></td><td><p>Gibt Informationen zum Objekt an, für das der Alarm gilt.</p><ul><li><code>hostname</code>: Zeigt den Namen des Objekts.</li><li><code>_id</code>: Zeigt die eindeutige Kennung des Objekts.</li></ul></td></tr></tbody></table>

***

## 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.

{% hint style="success" icon="lightbulb-exclamation" %}
Mehr Informationen, wie du einen benutzerdefinierten Payload mit dynamischen Platzhaltern erstellst, findest du in der Knowledge Base: [Wie erstelle ich für Enginsight Alarme eigene Webhook-Payloads mit dynamischen Platzhaltern?](/docs/knowledge-base/alarme/wie-erstelle-ich-fur-enginsight-alarme-eigene-webhook-payloads-mit-dynamischen-platzhaltern.md)
{% endhint %}

***