We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies. To learn more, read our Privacy Policy.

main-concepts

No menu items for this category
Home/Main Concepts/Metadata Standard/Schemas/Entity/Events/Webhook
Collate Documentation

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.