mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-09 01:58:53 +00:00
57 lines
2.8 KiB
Markdown
57 lines
2.8 KiB
Markdown
---
|
|
title: Webhooks
|
|
slug: /developers/webhooks
|
|
---
|
|
|
|
# Webhooks
|
|
|
|
A webhook is a way for an app to provide other applications with real-time information.
|
|
A webhook delivers data to other applications as it happens, meaning you get data immediately.
|
|
OpenMetadata out of the box provide support for Webhooks.
|
|
Webhooks can be used to get real-time information for the application when an event occurs.
|
|
OpenMetadata also allows the user to customise the webhook with a wide range of filters to listen to only selected type of events
|
|
|
|
|
|
## OpenMetadata supports 3 webhook types:
|
|
1. **Generic**
|
|
2. **Slack**
|
|
3. **Microsoft Teams**
|
|
|
|
## How to Set up Generic Type Webhook:
|
|
1. **Name**: Add the name of the webhook
|
|
2. **Description**: Add description of the webhook/Describe the webhook.
|
|
3. **Endpoint URL**: Enter the Consumer/client URL to consume the event's data.
|
|
4. **Activity Filter**: Can be used to activate or disable the webhook.
|
|
5. **Event Filters**: Filters are provided for all the entities and for all the events.
|
|
Event data for specific action can be achieved.
|
|
6. **Batch Size**: Enter the batch size.
|
|
7. **Connection Timeout**: Enter the desired connection timeout.
|
|
8. **Secret Key**: Secret key can be used to secure the webhook connection.
|
|
|
|
|
|
|
|
## How to Set up Slack Type Webhook:
|
|
1. **Name**: Add the name of the webhook
|
|
2. **Description**: Add description of the webhook/Describe the webhook.
|
|
3. **Endpoint URL**: Enter the Slack endpoint url.
|
|
4. **Activity Filter**: Can be used to activate or disable the webhook.
|
|
5. **Event Filters**: Filters are provided for all the entities and for all the events.
|
|
Event data for specific action can be achieved.
|
|
6. **Batch Size**: Enter the batch size.
|
|
7. **Connection Timeout**: Enter the desired connection timeout.
|
|
8. **Secret Key**: Secret key can be used to secure the webhook connection.
|
|
|
|
|
|
|
|
## How to Set up Microsoft Teams Type Webhook:
|
|
1. **Name**: Add the name of the webhook
|
|
2. **Description**: Add description of the webhook/Describe the webhook.
|
|
3. **Endpoint URL**: Enter the MS Teams endpoint url.
|
|
4. **Activity Filter**: Can be used to activate or disable the webhook.
|
|
5. **Event Filters**: Filters are provided for all the entities and for all the events.
|
|
Event data for specific action can be achieved.
|
|
6. **Batch Size**: Enter the batch size.
|
|
7. **Connection Timeout**: Enter the desired connection timeout.
|
|
8. **Secret Key**: Secret key can be used to secure the webhook connection.
|
|
|
|
 |