yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-02 11:39:12 +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
Pere Miquel Brull 34fbe5d64c
Docs - Prepare 1.7 docs and 1.8 snapshot (#20882) 
* DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT

* DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT
2025-04-18 12:12:17 +05:30

1.2 KiB
Raw Blame History

title slug
webhook /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.