mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-24 07:14:48 +00:00
* DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT * DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT
2.2 KiB
2.2 KiB
| title | slug |
|---|---|
| createEventSubscription | /main-concepts/metadata-standard/schemas/events/api/createeventsubscription |
CreateEventSubscription
This defines schema for sending alerts for OpenMetadata
Properties
name: Name that uniquely identifies this Alert. Refer to ../../type/basic.json#/definitions/entityName.displayName(string): Display name for this Alert.description: A short description of the Alert, comprehensible to regular users. Refer to ../../type/basic.json#/definitions/markdown.owners: Owners of this Alert. Refer to ../../type/entityReferenceList.json. Default:null.enabled(boolean): Is the alert enabled. Default:true.batchSize(integer): Maximum number of events sent in a batch (Default 10). Default:10.alertType: Type of Alert. Refer to ../eventSubscription.json#/definitions/alertType.trigger: Refer to ../eventSubscription.json#/definitions/trigger.resources(array): Defines a list of resources that triggers the Event Subscription, Eg All, User, Teams etc.- Items (string)
destinations(array): Subscription Config.- Items: Refer to ../../events/eventSubscription.json#/definitions/destination.
provider: Refer to ../../type/basic.json#/definitions/providerType.retries(integer): Number of times to retry callback on failure. (Default 3). Default:3.pollInterval(integer): Poll Interval in seconds. Default:10.input: Input for the Filters. Refer to ../eventSubscription.json#/definitions/alertFilteringInput.domain(string): Fully qualified name of the domain the Table belongs to.
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.