diff --git a/openmetadata-docs/content/v1.7.x/developers/webhooks.md b/openmetadata-docs/content/v1.7.x/developers/webhooks.md index 9c24d148550..1b51e5c2ec0 100644 --- a/openmetadata-docs/content/v1.7.x/developers/webhooks.md +++ b/openmetadata-docs/content/v1.7.x/developers/webhooks.md @@ -33,9 +33,10 @@ 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. **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. +3. **Destination**: Enter the **consumer or client URL** where the event data should be delivered. You can also configure the **Connection Timeout (seconds)** and **Read Timeout (seconds)** to manage request-response limits for the webhook call. +4. **Trigger**: Select important trigger events like **Schema Change**, **Test Failure**, or other metadata changes to generate an alert or notification. These events determine when the webhook will be executed. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. {% image @@ -47,9 +48,10 @@ 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. +3. **Destination**: Enter the Slack endpoint URL where the webhook data should be sent. This is the target endpoint that will receive the event payload. Ensure the Slack webhook URL is correctly configured to enable successful message delivery. +4. **Trigger**: Define the events that should activate the webhook. These include important system activities such as schema changes, test failures, or metadata updates. Selecting appropriate triggers ensures that alerts or notifications are generated for relevant actions. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. @@ -63,8 +65,9 @@ caption="Slack 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. +4. **Trigger**: Select key trigger events such as **Schema Change**, **Test Failure**, or other entity-specific actions. These events will initiate the webhook and send the corresponding event payload to the specified destination. This allows real-time monitoring and automated responses based on metadata changes. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. {% image @@ -77,8 +80,9 @@ caption="MS Team 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. +4. **Trigger**: Select key trigger events such as **Schema Change**, **Test Failure**, or other relevant actions. These events will activate the webhook and send real-time metadata change notifications to the configured GChat destination. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. {% image diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/developers/webhooks.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/developers/webhooks.md index 89275f62b19..40d2353f857 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/developers/webhooks.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/developers/webhooks.md @@ -33,9 +33,10 @@ 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. **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. +3. **Destination**: Enter the **consumer or client URL** where the event data should be delivered. You can also configure the **Connection Timeout (seconds)** and **Read Timeout (seconds)** to manage request-response limits for the webhook call. +4. **Trigger**: Select important trigger events like **Schema Change**, **Test Failure**, or other metadata changes to generate an alert or notification. These events determine when the webhook will be executed. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. {% image @@ -47,9 +48,10 @@ 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. +3. **Destination**: Enter the Slack endpoint URL where the webhook data should be sent. This is the target endpoint that will receive the event payload. Ensure the Slack webhook URL is correctly configured to enable successful message delivery. +4. **Trigger**: Define the events that should activate the webhook. These include important system activities such as schema changes, test failures, or metadata updates. Selecting appropriate triggers ensures that alerts or notifications are generated for relevant actions. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. @@ -63,8 +65,9 @@ caption="Slack 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. +4. **Trigger**: Select key trigger events such as **Schema Change**, **Test Failure**, or other entity-specific actions. These events will initiate the webhook and send the corresponding event payload to the specified destination. This allows real-time monitoring and automated responses based on metadata changes. +5. **Source**: Can be used to activate or disable the webhook. +6. **Filters**: Filters are provided for all the entities and for all the events. Event data for specific action can be achieved. {% image @@ -77,12 +80,13 @@ caption="MS Team 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. +4. **Trigger**: Select key trigger events such as **Schema Change**, **Test Failure**, or other relevant actions. These events will activate the webhook and send real-time metadata change notifications to the configured GChat destination. +5. **Source**: Can be used to activate or disable the webhook. +6. **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.8/developers/gchat.png" alt="Gchat Webhook" caption="Gchat Webhook" -/%} \ No newline at end of file +/%} diff --git a/openmetadata-docs/images/v1.7/developers/bot-listing.png b/openmetadata-docs/images/v1.7/developers/bot-listing.png index 5a5b6cfe4a9..6f5521a8d4b 100644 Binary files a/openmetadata-docs/images/v1.7/developers/bot-listing.png and b/openmetadata-docs/images/v1.7/developers/bot-listing.png differ diff --git a/openmetadata-docs/images/v1.7/developers/bot-token-generate.png b/openmetadata-docs/images/v1.7/developers/bot-token-generate.png index 04d3d9586aa..fa25aaba1ed 100644 Binary files a/openmetadata-docs/images/v1.7/developers/bot-token-generate.png and b/openmetadata-docs/images/v1.7/developers/bot-token-generate.png differ diff --git a/openmetadata-docs/images/v1.7/developers/bot-token-page.png b/openmetadata-docs/images/v1.7/developers/bot-token-page.png index e00a1ac2aa7..0557552b043 100644 Binary files a/openmetadata-docs/images/v1.7/developers/bot-token-page.png and b/openmetadata-docs/images/v1.7/developers/bot-token-page.png differ diff --git a/openmetadata-docs/images/v1.7/developers/create-bot.png b/openmetadata-docs/images/v1.7/developers/create-bot.png index ea680598a95..047ea927826 100644 Binary files a/openmetadata-docs/images/v1.7/developers/create-bot.png and b/openmetadata-docs/images/v1.7/developers/create-bot.png differ diff --git a/openmetadata-docs/images/v1.7/developers/gchat.png b/openmetadata-docs/images/v1.7/developers/gchat.png index 62dac3445a5..b304c7c4738 100644 Binary files a/openmetadata-docs/images/v1.7/developers/gchat.png and b/openmetadata-docs/images/v1.7/developers/gchat.png differ diff --git a/openmetadata-docs/images/v1.7/developers/generate-new-token.png b/openmetadata-docs/images/v1.7/developers/generate-new-token.png index 48156ed524e..698a272a31c 100644 Binary files a/openmetadata-docs/images/v1.7/developers/generate-new-token.png and b/openmetadata-docs/images/v1.7/developers/generate-new-token.png differ diff --git a/openmetadata-docs/images/v1.7/developers/msteam.png b/openmetadata-docs/images/v1.7/developers/msteam.png index d25cf1600b1..8099c686024 100644 Binary files a/openmetadata-docs/images/v1.7/developers/msteam.png and b/openmetadata-docs/images/v1.7/developers/msteam.png differ diff --git a/openmetadata-docs/images/v1.7/developers/settings-bot.png b/openmetadata-docs/images/v1.7/developers/settings-bot.png index 1754f2450a4..49b90591c46 100644 Binary files a/openmetadata-docs/images/v1.7/developers/settings-bot.png and b/openmetadata-docs/images/v1.7/developers/settings-bot.png differ diff --git a/openmetadata-docs/images/v1.7/developers/slack.png b/openmetadata-docs/images/v1.7/developers/slack.png index c67b9a2462e..5842633a1da 100644 Binary files a/openmetadata-docs/images/v1.7/developers/slack.png and b/openmetadata-docs/images/v1.7/developers/slack.png differ diff --git a/openmetadata-docs/images/v1.7/developers/webhook.png b/openmetadata-docs/images/v1.7/developers/webhook.png index ec185bc0e6f..b635f1c2de8 100644 Binary files a/openmetadata-docs/images/v1.7/developers/webhook.png and b/openmetadata-docs/images/v1.7/developers/webhook.png differ diff --git a/openmetadata-docs/images/v1.8/developers/bot-listing.png b/openmetadata-docs/images/v1.8/developers/bot-listing.png index 5a5b6cfe4a9..6f5521a8d4b 100644 Binary files a/openmetadata-docs/images/v1.8/developers/bot-listing.png and b/openmetadata-docs/images/v1.8/developers/bot-listing.png differ diff --git a/openmetadata-docs/images/v1.8/developers/bot-token-generate.png b/openmetadata-docs/images/v1.8/developers/bot-token-generate.png index 04d3d9586aa..fa25aaba1ed 100644 Binary files a/openmetadata-docs/images/v1.8/developers/bot-token-generate.png and b/openmetadata-docs/images/v1.8/developers/bot-token-generate.png differ diff --git a/openmetadata-docs/images/v1.8/developers/bot-token-page.png b/openmetadata-docs/images/v1.8/developers/bot-token-page.png index e00a1ac2aa7..0557552b043 100644 Binary files a/openmetadata-docs/images/v1.8/developers/bot-token-page.png and b/openmetadata-docs/images/v1.8/developers/bot-token-page.png differ diff --git a/openmetadata-docs/images/v1.8/developers/create-bot.png b/openmetadata-docs/images/v1.8/developers/create-bot.png index ea680598a95..047ea927826 100644 Binary files a/openmetadata-docs/images/v1.8/developers/create-bot.png and b/openmetadata-docs/images/v1.8/developers/create-bot.png differ diff --git a/openmetadata-docs/images/v1.8/developers/gchat.png b/openmetadata-docs/images/v1.8/developers/gchat.png index 62dac3445a5..b304c7c4738 100644 Binary files a/openmetadata-docs/images/v1.8/developers/gchat.png and b/openmetadata-docs/images/v1.8/developers/gchat.png differ diff --git a/openmetadata-docs/images/v1.8/developers/generate-new-token.png b/openmetadata-docs/images/v1.8/developers/generate-new-token.png index 48156ed524e..698a272a31c 100644 Binary files a/openmetadata-docs/images/v1.8/developers/generate-new-token.png and b/openmetadata-docs/images/v1.8/developers/generate-new-token.png differ diff --git a/openmetadata-docs/images/v1.8/developers/msteam.png b/openmetadata-docs/images/v1.8/developers/msteam.png index d25cf1600b1..8099c686024 100644 Binary files a/openmetadata-docs/images/v1.8/developers/msteam.png and b/openmetadata-docs/images/v1.8/developers/msteam.png differ diff --git a/openmetadata-docs/images/v1.8/developers/settings-bot.png b/openmetadata-docs/images/v1.8/developers/settings-bot.png index 1754f2450a4..49b90591c46 100644 Binary files a/openmetadata-docs/images/v1.8/developers/settings-bot.png and b/openmetadata-docs/images/v1.8/developers/settings-bot.png differ diff --git a/openmetadata-docs/images/v1.8/developers/slack.png b/openmetadata-docs/images/v1.8/developers/slack.png index c67b9a2462e..5842633a1da 100644 Binary files a/openmetadata-docs/images/v1.8/developers/slack.png and b/openmetadata-docs/images/v1.8/developers/slack.png differ diff --git a/openmetadata-docs/images/v1.8/developers/webhook.png b/openmetadata-docs/images/v1.8/developers/webhook.png index ec185bc0e6f..b635f1c2de8 100644 Binary files a/openmetadata-docs/images/v1.8/developers/webhook.png and b/openmetadata-docs/images/v1.8/developers/webhook.png differ