diff --git a/openmetadata-docs/content/v1.4.x/developers/webhooks.md b/openmetadata-docs/content/v1.4.x/developers/webhooks.md deleted file mode 100644 index 8029a0a4f88..00000000000 --- a/openmetadata-docs/content/v1.4.x/developers/webhooks.md +++ /dev/null @@ -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. - -![webhook-generic](https://user-images.githubusercontent.com/83201188/188461969-7f318869-4048-4625-a896-da88bce811c2.png) - -## 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. - -![webhook-slack](https://user-images.githubusercontent.com/83201188/188462920-2028f777-af0e-4868-b4d2-01e45f520a25.png) - -## 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. - -![webhook-msteams](https://user-images.githubusercontent.com/83201188/188462667-bd8443ce-a07d-4742-ae5d-42da3fc2d402.png) - -## 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. \ No newline at end of file diff --git a/openmetadata-docs/content/v1.4.x/how-to-guides/data-quality-observability/observability/webhooks.md b/openmetadata-docs/content/v1.4.x/how-to-guides/data-quality-observability/observability/webhooks.md new file mode 100644 index 00000000000..2b5078041b9 --- /dev/null +++ b/openmetadata-docs/content/v1.4.x/how-to-guides/data-quality-observability/observability/webhooks.md @@ -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" +/%} \ No newline at end of file diff --git a/openmetadata-docs/content/v1.4.x/menu.md b/openmetadata-docs/content/v1.4.x/menu.md index 7c8f4c0158a..29ff169df04 100644 --- a/openmetadata-docs/content/v1.4.x/menu.md +++ b/openmetadata-docs/content/v1.4.x/menu.md @@ -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 diff --git a/openmetadata-docs/content/v1.5.x-SNAPSHOT/developers/webhooks.md b/openmetadata-docs/content/v1.5.x-SNAPSHOT/developers/webhooks.md index 8029a0a4f88..3a30e79a808 100644 --- a/openmetadata-docs/content/v1.5.x-SNAPSHOT/developers/webhooks.md +++ b/openmetadata-docs/content/v1.5.x-SNAPSHOT/developers/webhooks.md @@ -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. -![webhook-generic](https://user-images.githubusercontent.com/83201188/188461969-7f318869-4048-4625-a896-da88bce811c2.png) +{% 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. -![webhook-slack](https://user-images.githubusercontent.com/83201188/188462920-2028f777-af0e-4868-b4d2-01e45f520a25.png) + +{% 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. -![webhook-msteams](https://user-images.githubusercontent.com/83201188/188462667-bd8443ce-a07d-4742-ae5d-42da3fc2d402.png) +{% 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. \ No newline at end of file + +{% image +src="/images/v1.5/developers/gchat.png" +alt="Gchat Webhook" +caption="Gchat Webhook" +/%} \ No newline at end of file diff --git a/openmetadata-docs/images/v1.4/how-to-guides/observability/gchat.png b/openmetadata-docs/images/v1.4/how-to-guides/observability/gchat.png new file mode 100644 index 00000000000..62dac3445a5 Binary files /dev/null and b/openmetadata-docs/images/v1.4/how-to-guides/observability/gchat.png differ diff --git a/openmetadata-docs/images/v1.4/how-to-guides/observability/msteam.png b/openmetadata-docs/images/v1.4/how-to-guides/observability/msteam.png new file mode 100644 index 00000000000..d25cf1600b1 Binary files /dev/null and b/openmetadata-docs/images/v1.4/how-to-guides/observability/msteam.png differ diff --git a/openmetadata-docs/images/v1.4/how-to-guides/observability/slack.png b/openmetadata-docs/images/v1.4/how-to-guides/observability/slack.png new file mode 100644 index 00000000000..c67b9a2462e Binary files /dev/null and b/openmetadata-docs/images/v1.4/how-to-guides/observability/slack.png differ diff --git a/openmetadata-docs/images/v1.4/how-to-guides/observability/webhook.png b/openmetadata-docs/images/v1.4/how-to-guides/observability/webhook.png new file mode 100644 index 00000000000..ec185bc0e6f Binary files /dev/null and b/openmetadata-docs/images/v1.4/how-to-guides/observability/webhook.png differ diff --git a/openmetadata-docs/images/v1.5/developers/gchat.png b/openmetadata-docs/images/v1.5/developers/gchat.png new file mode 100644 index 00000000000..62dac3445a5 Binary files /dev/null and b/openmetadata-docs/images/v1.5/developers/gchat.png differ diff --git a/openmetadata-docs/images/v1.5/developers/msteam.png b/openmetadata-docs/images/v1.5/developers/msteam.png new file mode 100644 index 00000000000..d25cf1600b1 Binary files /dev/null and b/openmetadata-docs/images/v1.5/developers/msteam.png differ diff --git a/openmetadata-docs/images/v1.5/developers/slack.png b/openmetadata-docs/images/v1.5/developers/slack.png new file mode 100644 index 00000000000..c67b9a2462e Binary files /dev/null and b/openmetadata-docs/images/v1.5/developers/slack.png differ diff --git a/openmetadata-docs/images/v1.5/developers/webhook.png b/openmetadata-docs/images/v1.5/developers/webhook.png new file mode 100644 index 00000000000..ec185bc0e6f Binary files /dev/null and b/openmetadata-docs/images/v1.5/developers/webhook.png differ