yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-30 09:36:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.7.x/main-concepts/metadata-standard/schemas/entity/events/webhook.md
Rounak Dhillon d4728d13f5
Docs: Meta Description Updation (#22611) 
Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
2025-07-28 18:24:51 +05:30

1.4 KiB
Raw Blame History

title description slug
Webhook Schema | OpenMetadata Webhook Schema Details Represent webhook configuration and events for real-time data sync and external system integration. /main-concepts/metadata-standard/schemas/entity/events/webhook

Webhook

This schema defines webhook for receiving events from OpenMetadata.

Properties

  • receivers (array): List of receivers to send mail to.
    • Items (string)
  • endpoint (string, format: uri): Endpoint to receive the webhook events over POST requests.
  • secretKey (string): Secret set by the webhook client used for computing HMAC SHA256 signature of webhook payload and sent in X-OM-Signature header in POST requests to publish the events.
  • headers (object): Custom headers to be sent with the webhook request.
  • httpMethod (string): HTTP operation to send the webhook request. Supports POST or PUT. Must be one of: ["POST", "PUT"]. Default: "POST".
  • sendToAdmins (boolean): Send the Event to Admins. Default: false.
  • sendToOwners (boolean): Send the Event to Owners. Default: false.
  • sendToFollowers (boolean): Send the Event to Followers. Default: false.

Definitions

  • entityName (string): Unique name of the application receiving webhook events.

Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.