Doc: Developer Images Updation (#21077)
@ -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
|
||||
|
@ -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"
|
||||
/%}
|
||||
/%}
|
||||
|
Before Width: | Height: | Size: 490 KiB After Width: | Height: | Size: 393 KiB |
Before Width: | Height: | Size: 327 KiB After Width: | Height: | Size: 311 KiB |
Before Width: | Height: | Size: 609 KiB After Width: | Height: | Size: 400 KiB |
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 169 KiB |
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 123 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 480 KiB After Width: | Height: | Size: 439 KiB |
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 225 KiB After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 490 KiB After Width: | Height: | Size: 393 KiB |
Before Width: | Height: | Size: 327 KiB After Width: | Height: | Size: 311 KiB |
Before Width: | Height: | Size: 609 KiB After Width: | Height: | Size: 400 KiB |
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 169 KiB |
Before Width: | Height: | Size: 228 KiB After Width: | Height: | Size: 123 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 480 KiB After Width: | Height: | Size: 439 KiB |
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 225 KiB After Width: | Height: | Size: 119 KiB |