2023-08-27 10:55:55 +02:00
---
title: webhook
slug: /main-concepts/metadata-standard/schemas/entity/events/webhook
---
# Webhook
*This schema defines webhook for receiving events from OpenMetadata.*
## Properties
2025-01-15 17:46:55 +05:30
- **`receivers` ** *(array)* : List of receivers to send mail to.
- **Items** *(string)*
- **`endpoint` ** *(string, format: uri)* : Endpoint to receive the webhook events over POST requests.
2023-08-27 10:55:55 +02:00
- **`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.
2025-01-15 17:46:55 +05:30
- **`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` .
2023-08-27 10:55:55 +02:00
## Definitions
- **`entityName` ** *(string)* : Unique name of the application receiving webhook events.
2025-01-15 17:46:55 +05:30
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.
