> 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/manual/english/platform-usage/alerts/management/webhooks.md).

# Webhooks

With webhooks, you can connect alerts to third-party applications so that you can receive notifications outside the Enginsight platform.

***

<i class="fa-compass">:compass:</i> Navigate to **Alerts** → **Webhooks** to show a list of all created webhooks. If you have not created any webhooks yet, this view is empty.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F3oymmUx4v6GozgNX9xHy%2Fenginsight-screenshot-alerts-management-webhooks.jpg?alt=media&amp;token=729fc755-4c7f-4318-b673-cba78dd41c53" alt=""><figcaption></figcaption></figure>

The [webhooks overview](#webhooks-overview) provides information such as:

* which HTTP method a webhook uses.
* which target URL is configured for the webhook.

You can also export webhooks and [create new webhooks](#option-1-create-a-new-webhook).

***

## Navigation

<i class="fa-magnifying-glass">:magnifying-glass:</i> Click the **Text Search** field above the list and enter a search term of your choice to find specific list items more quickly.

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Refresh** icon <i class="fa-arrows-rotate-reverse">:arrows-rotate-reverse:</i> above the list to update all list items.

<i class="fa-computer-mouse-scrollwheel">:computer-mouse-scrollwheel:</i> Scroll down the list or adjust the number of results shown per page ![](https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FfjKACCt2SKXcFd3S7Xb5%2FEnginsight-EN-Results%20per%20Page.jpg?alt=media\&token=e1650160-7a41-4965-aaca-6975db758dbe) to view additional entries. Use the page navigation ![](https://content.gitbook.com/content/V7OrHgKXA0t1jankQBYf/blobs/wnxVw06QGoSsYjhwMJRF/Enginsight-Seitennavigation-2.jpg) to switch between pages.&#x20;

### Sorting List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Sort** icon <i class="fa-sort">:sort:</i> next to a column name in the table header to sort by that column in ascending <i class="fa-angle-up">:angle-up:</i> or descending order <i class="fa-chevron-down">:chevron-down:</i> .

<i class="fa-computer-mouse">:computer-mouse:</i> Click the sort icon <i class="fa-bars-sort">:bars-sort:</i> above the list to adjust the priority of the applied sorting. A menu opens that shows all columns by which the list is currently sorted. Drag and drop the shown items to change the sorting priority.

### Further Actions for List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Select the checkbox <i class="fa-square">:square:</i> next to a list item to select the respective item. Alternatively, select the checkbox in the table header to select all list items.

The number of selected list items is now shown next to the search field.

The <i class="fa-slider">:slider:</i> **Actions** menu also appears in the upper-right corner. Click it to expand the respective submenu. The following actions are available:

<table><thead><tr><th width="149.84375">Action</th><th>Description</th></tr></thead><tbody><tr><td>Export Selection</td><td><p>Export all selected objects. </p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Export Selection</strong> to open a new window where you can configure additional <a href="#export-webhooks">export settings</a>.</p></td></tr><tr><td>Delete</td><td><p>Delete all selected objects. </p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Delete</strong> and confirm the message that appears by clicking <strong>Delete Irretrievably</strong>. </p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note:</strong> Deleted items cannot be restored.</p></div></td></tr></tbody></table>

***

## Webhooks: Overview

The webhooks overview is structured as a table.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FTtENK7mUYyMZ4o8snTwD%2Fenginsight-screenshot-alerts-management-webhooks%20overview.jpg?alt=media&amp;token=38ea4725-a9b3-4a9a-9082-2c8bf22bce0e" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="199.98046875">Column</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td><p>Shows the custom name of the webhook.</p><p></p><p>The date and time of creation and last edit are also shown.</p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a webhook to navigate to the respective <a href="#webhook-edit-view">edit view</a>. Here you can adjust configured settings and delete the webhook.</p></td></tr><tr><td>Method</td><td><p>Shows the HTTP method that you defined for the webhook.</p><p></p><p>The following methods can be shown:</p><ul><li><strong>GET</strong>: The webhook retrieves data from the target system.</li><li><strong>POST</strong>: The webhook creates new data in the target system or sends data to the target system.</li><li><strong>PATCH</strong>: The webhook partially updates existing data in the target system.</li><li><strong>PUT</strong>: The webhook fully updates existing data in the target system.</li><li><strong>DELETE</strong>: The webhook deletes existing data in the target system.</li></ul></td></tr><tr><td>Target</td><td>Shows the target URL to which the webhook request is sent.</td></tr><tr><td>Content Type</td><td>Shows the content format of the webhook request.</td></tr></tbody></table>

***

## Adding a Webhook

You have two options for adding a webhook. You can either create new webhooks or import webhooks that you [previously exported](#export-webhooks), for example from other organizations.

### Option 1: Creating a New Webhook

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-plus">:plus:</i> **Add Webhook** in the upper-right corner and select <i class="fa-plus">:plus:</i> **Create New** from the submenu that opens to [create a new webhook](/docs/manual/english/platform-usage/alerts/management/webhooks/add-webhook.md#create-a-new-webhook).

### Option 2: Importing a Webhook

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-plus">:plus:</i> **Add Webhook** in the upper-right corner and select <i class="fa-up-from-line">:up-from-line:</i> **Import** from the submenu that opens to [import one or more webhooks](/docs/manual/english/platform-usage/alerts/management/webhooks/add-webhook.md#import-webhooks).

***

## Exporting Webhooks

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-down-to-line">:down-to-line:</i> **Export Webhooks** in the upper-right corner to open a new window in which you can configure additional export settings.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FKvix5bu1vCzrDIWqEkGw%2Fenginsight-screenshot-alerts-management-webhooks-export.jpg?alt=media&amp;token=c572b198-ad71-4eaf-a68e-ade3d3465839" alt="" width="375"><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Export All** to download all or only the selected webhooks. The export is provided in ZIP format.

{% hint style="info" %}
You can find the exported file in the default download location of your browser.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Abort** to return to the list overview.

### Assigned Webhooks

Here you can specify which webhooks should be exported.

{% hint style="info" %}
Specifying assigned webhooks is optional.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> To do this, click the **Webhooks** field to expand a list of all available webhooks and select one or more webhooks to export.

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Remove** icon <i class="fa-circle-x">:circle-x:</i> next to an added webhook to remove it from the **Webhooks** field again.

#### Excluded Webhooks

Here you can specify which webhooks should be excluded from the export.

{% hint style="info" %}
Specifying excluded webhooks is optional.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-plus">:plus:</i> **Define Exceptions** to show the options for **Excluded Webhooks**.

<i class="fa-gear">:gear:</i> Configure all settings in the same way as for an [assigned webhook](#assigned-webhooks).

***

## Webhook: Edit View

<i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a webhook to navigate to the respective edit view. Here you can adjust [configured settings](/docs/manual/english/platform-usage/alerts/management/webhooks/add-webhook.md#create-a-new-webhook) and delete the webhook.

The following actions are available:

<table><thead><tr><th width="200.39453125">Option</th><th>Description</th></tr></thead><tbody><tr><td>Save Changes</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Save Changes</strong> after adjusting any settings.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note:</strong> Unsaved changes cannot be recovered.</p></div></td></tr><tr><td>Back</td><td><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Back</strong> to return to the list overview.</td></tr><tr><td>Remove</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Remove</strong>, then confirm the prompt that appears to delete the object that you are editing.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note:</strong> Deleted objects cannot be recovered.</p></div></td></tr></tbody></table>

### Webhook URL Calls

Once a webhook URL has been called, a list of all requests appears on the right-hand side of the edit view.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FTPLZQ0Bl2O0fXLwVJntQ%2Fenginsight-screenshot-alerts-management-webhooks-webhook%20url%20calls.jpg?alt=media&amp;token=3ecbea9d-01ee-40e1-b366-ddfe7ffc4e4b" alt="" width="563"><figcaption></figcaption></figure></div>

The following information is shown:

<table><thead><tr><th width="209.03125">Column</th><th>Description</th></tr></thead><tbody><tr><td>Status</td><td>Shows the HTTP status that was returned in response to the HTTP request.</td></tr><tr><td>Method</td><td>Shows the HTTP method selected for the webhook.</td></tr><tr><td>Destination</td><td>Shows the destination URL to which the webhook request was sent.</td></tr><tr><td>Created At</td><td>Shows the date and time at which the webhook URL was called.</td></tr></tbody></table>

***
