mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2026-01-07 04:56:54 +00:00
Doc: Updating Webhooks Docs (#16915)
Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
This commit is contained in:
Prajwal214
GitHub
parent
a9f6bd4ed1
commit
f5abfdacfe
@ -1,81 +0,0 @@
|
||||
---
|
||||
title: Webhooks
|
||||
slug: /developers/webhooks
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
# Webhooks
|
||||
|
||||
In 0.13.1 , webhooks have been deprecated. You should instead use [OpenMetadata alerts](/how-to-guides/admin-guide/alerts)
|
||||
|
||||
Before upgrading to 0.13.1 it is recommended to save the existing Webhook configs(like webhook url) to use them later.
|
||||
|
||||
We have added Alerts/Notifications , which can be configured to receive customised alerts on updates in OM using Triggers, Filtering Information to different destinations like Slack, MsTeams or even Emails.
|
||||
Please use the same webhook config that you had saved from previous version to configure the Alerts Destination after upgrading.
|
||||
|
||||
{% /note %}
|
||||
|
||||
# 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 provides out-of-the-box support for webhooks.
|
||||
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 4 webhook types:
|
||||
1. **Generic**
|
||||
2. **Slack**
|
||||
3. **Microsoft Teams**
|
||||
4. **Google Chat**
|
||||
|
||||
## How to Set up Generic Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: 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**: 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**: Describe the webhook.
|
||||
3. **Endpoint URL**: Enter the MS Teams endpoint URL. You can find this by going to the Teams channel where you want the posts to appear, clicking the three dots `...`, and clicking "Connectors". Then add the "Incoming Webhook" connector. Copy this connector's URL and supply it here to OpenMetadata. It may be in the form of `https://your-domain.webhook.office.com/webhookb2/...@.../IncomingWebhook/.../...`. For more on MS Teams webhooks, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
|
||||
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 Google Chat Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Endpoint URL**: Enter the GChat endpoint URL. For more on creating GChat webhooks, see [Create a Webhook](https://developers.google.com/chat/how-tos/webhooks#create_a_webhook).
|
||||
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.
|
||||
@ -0,0 +1,88 @@
|
||||
---
|
||||
title: Webhooks
|
||||
slug: /how-to-guides/data-quality-observability/observability/webhooks
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
# Webhooks
|
||||
|
||||
In 0.13.1 , webhooks have been deprecated. You should instead use [OpenMetadata alerts](/how-to-guides/admin-guide/alerts)
|
||||
|
||||
Before upgrading to 0.13.1 it is recommended to save the existing Webhook configs(like webhook url) to use them later.
|
||||
|
||||
We have added Alerts/Notifications , which can be configured to receive customised alerts on updates in OM using Triggers, Filtering Information to different destinations like Slack, MsTeams or even Emails.
|
||||
Please use the same webhook config that you had saved from previous version to configure the Alerts Destination after upgrading.
|
||||
|
||||
{% /note %}
|
||||
|
||||
# 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 provides out-of-the-box support for webhooks.
|
||||
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 4 webhook types:
|
||||
1. **Generic**
|
||||
2. **Slack**
|
||||
3. **Microsoft Teams**
|
||||
4. **Google Chat**
|
||||
|
||||
## How to Set up Generic Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Destination**: Enter the Consumer/client URL to consume the event's data.
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **Filters**: Filters are provided for all the entities and for all the events.
|
||||
Event data for specific action can be achieved.
|
||||
|
||||
{% image
|
||||
src="/images/v1.4/how-to-guides/observability/webhook.png"
|
||||
alt="Generic Webhook"
|
||||
caption="Generic Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Slack Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Destination**: Enter the Slack endpoint URL.
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **Filters**: Filters are provided for all the entities and for all the events.
|
||||
Event data for specific action can be achieved.
|
||||
|
||||
|
||||
{% image
|
||||
src="/images/v1.4/how-to-guides/observability/slack.png"
|
||||
alt="Slack Webhook"
|
||||
caption="Slack Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Microsoft Teams Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Destination**: Enter the MS Teams endpoint URL. You can find this by going to the Teams channel where you want the posts to appear, clicking the three dots `...`, and clicking "Connectors". Then add the "Incoming Webhook" connector. Copy this connector's URL and supply it here to OpenMetadata. It may be in the form of `https://your-domain.webhook.office.com/webhookb2/...@.../IncomingWebhook/.../...`. For more on MS Teams webhooks, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **Filters**: Filters are provided for all the entities and for all the events.
|
||||
Event data for specific action can be achieved.
|
||||
|
||||
{% image
|
||||
src="/images/v1.4/how-to-guides/observability/msteam.png"
|
||||
alt="MS Team Webhook"
|
||||
caption="MS Team Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Google Chat Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Destination**: Enter the GChat endpoint URL. For more on creating GChat webhooks, see [Create a Webhook](https://developers.google.com/chat/how-tos/webhooks#create_a_webhook).
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **Filters**: Filters are provided for all the entities and for all the events.
|
||||
Event data for specific action can be achieved.
|
||||
|
||||
{% image
|
||||
src="/images/v1.4/how-to-guides/observability/gchat.png"
|
||||
alt="Gchat Webhook"
|
||||
caption="Gchat Webhook"
|
||||
/%}
|
||||
@ -780,6 +780,8 @@ site_menu:
|
||||
url: /how-to-guides/data-quality-observability/observability
|
||||
- category: How-to Guides / Data Quality and Observability / Data Observability / Observability Alerts
|
||||
url: /how-to-guides/data-quality-observability/observability/alerts
|
||||
- category: How-to Guides / Data Quality and Observability / Data Observability / Webhooks
|
||||
url: /how-to-guides/data-quality-observability/observability/webhooks
|
||||
- category: How-to Guides / Data Quality and Observability / Incident Manager
|
||||
url: /how-to-guides/data-quality-observability/incident-manager
|
||||
- category: How-to Guides / Data Quality and Observability / Incident Manager / How to work with the Incident Manager
|
||||
@ -1908,8 +1910,6 @@ site_menu:
|
||||
url: /developers/contribute/developing-a-new-connector/update-documentation
|
||||
- category: Developers / Contribute / UX Style Guide
|
||||
url: /developers/contribute/ux-style-guide
|
||||
- category: Developers / Webhooks
|
||||
url: /developers/webhooks
|
||||
- category: Developers / Bots
|
||||
url: /developers/bots
|
||||
- category: Developers / Add Language Support
|
||||
|
||||
@ -33,49 +33,56 @@ OpenMetadata also allows the user to customise the webhook with a wide range of
|
||||
## How to Set up Generic Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: 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.
|
||||
3. **Destination**: Enter the Consumer/client URL to consume the event's data.
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **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.
|
||||
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/developers/webhook.png"
|
||||
alt="Generic Webhook"
|
||||
caption="Generic Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Slack Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: 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.
|
||||
3. **Destination**: Enter the Slack endpoint URL.
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **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.
|
||||
|
||||
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/developers/slack.png"
|
||||
alt="Slack Webhook"
|
||||
caption="Slack Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Microsoft Teams Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Endpoint URL**: Enter the MS Teams endpoint URL. You can find this by going to the Teams channel where you want the posts to appear, clicking the three dots `...`, and clicking "Connectors". Then add the "Incoming Webhook" connector. Copy this connector's URL and supply it here to OpenMetadata. It may be in the form of `https://your-domain.webhook.office.com/webhookb2/...@.../IncomingWebhook/.../...`. For more on MS Teams webhooks, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
|
||||
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.
|
||||
3. **Destination**: Enter the MS Teams endpoint URL. You can find this by going to the Teams channel where you want the posts to appear, clicking the three dots `...`, and clicking "Connectors". Then add the "Incoming Webhook" connector. Copy this connector's URL and supply it here to OpenMetadata. It may be in the form of `https://your-domain.webhook.office.com/webhookb2/...@.../IncomingWebhook/.../...`. For more on MS Teams webhooks, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **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.
|
||||
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/developers/msteam.png"
|
||||
alt="MS Team Webhook"
|
||||
caption="MS Team Webhook"
|
||||
/%}
|
||||
|
||||
## How to Set up Google Chat Type Webhook:
|
||||
1. **Name**: Add the name of the webhook
|
||||
2. **Description**: Describe the webhook.
|
||||
3. **Endpoint URL**: Enter the GChat endpoint URL. For more on creating GChat webhooks, see [Create a Webhook](https://developers.google.com/chat/how-tos/webhooks#create_a_webhook).
|
||||
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.
|
||||
3. **Destination**: Enter the GChat endpoint URL. For more on creating GChat webhooks, see [Create a Webhook](https://developers.google.com/chat/how-tos/webhooks#create_a_webhook).
|
||||
4. **Source**: Can be used to activate or disable the webhook.
|
||||
5. **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.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/developers/gchat.png"
|
||||
alt="Gchat Webhook"
|
||||
caption="Gchat Webhook"
|
||||
/%}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 228 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 225 KiB |
BIN
openmetadata-docs/images/v1.5/developers/gchat.png
Normal file
BIN
openmetadata-docs/images/v1.5/developers/gchat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 228 KiB |
BIN
openmetadata-docs/images/v1.5/developers/msteam.png
Normal file
BIN
openmetadata-docs/images/v1.5/developers/msteam.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
BIN
openmetadata-docs/images/v1.5/developers/slack.png
Normal file
BIN
openmetadata-docs/images/v1.5/developers/slack.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
BIN
openmetadata-docs/images/v1.5/developers/webhook.png
Normal file
BIN
openmetadata-docs/images/v1.5/developers/webhook.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 225 KiB |
Loading…
x
Reference in New Issue
Block a user