yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-12 03:29:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/developers/webhooks.md
Sam Firke 81c6dc493f
document MS Teams webhook (#8356)
2022-10-26 06:04:38 -07:00

3.1 KiB
Raw Blame History

title slug
Webhooks /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 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 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: 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

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

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.
  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