> 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/english/alerting/which-standard-templates-for-webhook-payloads-are-available-for-alerts-in-enginsight.md).

# Which standard templates for webhook payloads are available for alerts in Enginsight?

Webhooks allow you to connect alerts to third-party applications so that you can receive notifications outside the Enginsight platform, for example in a messenger or an external ticketing system.

For this, Enginsight sends an HTTP request, typically POST, to the specified webhook URL and includes a payload, that is, specific content in JSON format.

{% hint style="success" icon="lightbulb-exclamation" %}
For more information on how to create a webhook in the Enginsight platform, see the Enginsight Manual: [Add Webhook](https://docs.enginsight.com/docs/manual/english/platform-usage/alerts/webhooks/add-webhook)
{% endhint %}

***

## Standard Payload Templates

Depending on the alert type to which a webhook has been assigned, there are two standard JSON templates for the webhook payload: one for [metric-based alerts](#payload-template-for-webhooks-for-metric-based-alerts) and one for [scenario-based alerts](#payload-template-for-webhooks-for-scenario-based-alerts).

{% hint style="success" icon="lightbulb-exclamation" %}
For more information on how to create an alert in the Enginsight platform, see the Enginsight Manual: [Add Alert](https://docs.enginsight.com/docs/manual/english/platform-usage/alerts/overview/add-alert). For more information about available alerts, see the Knowledge Base: [Which specific alerts can I define in Enginsight?](/docs/knowledge-base/english/alerting/which-specific-alerts-can-i-define-in-enginsight.md)
{% endhint %}

### Payload Template for Webhooks for Metric-Based Alerts

A standard payload for webhooks for metric-based alerts looks as follows:

```
{
    "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>Description</th></tr></thead><tbody><tr><td><code>resolved</code></td><td><p>Specifies the status of the alert:</p><ul><li><code>false</code>: The occurrence (issue or incident) that triggered the alert has not yet been resolved.</li><li><code>true</code>: The occurrence (issue or incident) that triggered the alert has been resolved.</li></ul></td></tr><tr><td><code>belongsTo</code></td><td>Specifies the type of object to which the alert applies, for example <code>host</code> or <code>endpoint</code>.</td></tr><tr><td><code>alert</code></td><td><p>Provides information about the alert:</p><ul><li><code>name</code>: Shows the name of the alert.</li><li><code>_id</code>: Shows the unique identifier of the alert.</li><li><code>description</code>: Shows the custom description of the alert, if specified.</li></ul></td></tr><tr><td><code>organisationID</code></td><td>Specifies the unique identifier of the organization affected by the alert.</td></tr><tr><td><code>organisationName</code></td><td>Specifies the name of the organization affected by the alert.</td></tr><tr><td><code>property</code></td><td><p>Provides information about the metric that triggered the alert:</p><ul><li><code>result</code>: Shows the actual measured value.</li><li><code>expected</code>: Shows the expected threshold value.</li><li><p><code>operator</code>: Shows the operator that applies to the threshold value.</p><ul><li><code>gt</code>: greater than</li><li><code>lt</code>: lower than</li><li><code>eq</code>: equals</li></ul></li><li><p><code>aggregator</code>: Shows the aggregator that determines how the values measured per data point are aggregated and displayed.</p><ul><li><code>avg</code>: average value</li><li><code>min</code>: minimum value</li><li><code>max</code>: maximum value</li></ul></li><li><code>name</code>: Shows the internal name of the monitored metric.</li></ul></td></tr><tr><td><code>reference</code></td><td><p>Provides information about the object to which the alert applies.</p><ul><li><code>hostname</code>: Shows the name of the object.</li><li><code>_id</code>: Shows the unique identifier of the object.</li></ul></td></tr></tbody></table>

### Payload Template for Webhooks for Scenario-Based Alerts

A standard payload for webhooks for scenario-based alerts looks as follows:

```
{
    "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>Description</th></tr></thead><tbody><tr><td><code>resolved</code></td><td><p>Specifies the status of the alert:</p><ul><li><code>false</code>: The occurrence (issue or incident) that triggered the alert has not yet been resolved.</li><li><code>true</code>: The occurrence (issue or incident) that triggered the alert has been resolved.</li></ul></td></tr><tr><td><code>belongsTo</code></td><td>Specifies the type of object to which the alert applies, for example <code>host</code> or <code>endpoint</code>.</td></tr><tr><td><code>alert</code></td><td><p>Provides information about the alert:</p><ul><li><code>name</code>: Shows the name of the alert.</li><li><code>_id</code>: Shows the unique identifier of the alert.</li><li><code>description</code>: Shows the custom description of the alert, if specified.</li></ul></td></tr><tr><td><code>organisationID</code></td><td>Specifies the unique identifier of the organization affected by the alert.</td></tr><tr><td><code>organisationName</code></td><td>Specifies the name of the organization affected by the alert.</td></tr><tr><td><code>scenario</code></td><td><p>Provides information about the scenario that triggered the alert:</p><ul><li><code>name</code>: Shows the name or type of the scenario.</li><li><code>payload</code>: Shows additional details about values that triggered the alert as key-value pairs, for example the last availability of a website.</li></ul></td></tr><tr><td><code>reference</code></td><td><p>Provides information about the object to which the alert applies.</p><ul><li><code>hostname</code>: Shows the name of the object.</li><li><code>_id</code>: Shows the unique identifier of the object.</li></ul></td></tr></tbody></table>

***

## Custom Payloads

If you do not want to use either of the standard templates, you can also specify a custom payload in which you can use dynamic placeholders.

{% hint style="success" icon="lightbulb-exclamation" %}
For more information on how to create a custom payload with dynamic placeholders, see the Knowledge Base: [How do I create custom webhook payloads with dynamic placeholders for alerts in Enginsight?](/docs/knowledge-base/english/alerting/how-do-i-create-custom-webhook-payloads-with-dynamic-placeholders-for-alerts-in-enginsight.md)
{% endhint %}

***