json.schema.entity.events.webhook.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/entity/events/webhook.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Webhook",
"description": "This schema defines webhook for receiving events from OpenMetadata.",
"type": "object",
"javaType": "org.openmetadata.schema.type.Webhook",
"javaInterfaces": [
"org.openmetadata.schema.SubscriptionAction"
],
"definitions": {
"entityName" : {
"description": "Unique name of the application receiving webhook events.",
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "(?U)^[\\w'\\-.]+$"
}
},
"properties": {
"receivers": {
"description": "List of receivers to send mail to",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"endpoint": {
"description": "Endpoint to receive the webhook events over POST requests.",
"type": "string",
"format": "uri"
},
"secretKey": {
"description": "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.",
"type": "string"
},
"sendToAdmins": {
"description": "Send the Event to Admins",
"type": "boolean",
"default": false
},
"sendToOwners": {
"description": "Send the Event to Owners",
"type": "boolean",
"default": false
},
"sendToFollowers": {
"description": "Send the Event to Followers",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}