Update an Alert
Update an alert (event subscription) with JSON Patch or by sending the full definition again through the OpenMetadata REST API or Python SDK.
PATCH
PATCH /v1/events/subscriptions/{id}
Update an Alert
Update an alert in one of two ways:- Send the full definition with
PUT /v1/events/subscriptions. OpenMetadata matches onname, so a request with an existing name replaces the alert’s configuration. This is the simplest option for managing alerts as code. - Patch individual fields with JSON Patch.
Update with JSON Patch
- By ID:
PATCH /v1/events/subscriptions/{id} - By name:
PATCH /v1/events/subscriptions/name/{name}
Content-Type header to application/json-patch+json.
string
required
UUID of the alert.
PATCH /v1/events/subscriptions/{id}
Notes
Keep these points in mind when you update an alert.- Delivery restart: after an update, OpenMetadata restarts the alert’s delivery process so the change takes effect for new events.
- Changing filters or triggers: to change
input(filters and triggers) ordestinations, send the full definition withPUT. This is more reliable than patching the nestedinputfield, because OpenMetadata rebuilds the expanded conditions from the full request. - One source: an alert always has exactly one
resourcesvalue, whether you update it by sending the full definition or by patching. - Existing events: an update doesn’t replay past events.