How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Notification Templates API

Notification templates for customizing event notifications

OpenMetadata Notification Templates API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 20 operations across 14 paths, and defines 34 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

20 operations 14 paths 34 schemas 3 DELETE7 GET2 PATCH4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Notification Templates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 14 paths, the API surfaces 20 operations — 3 DELETE, 7 GET, 2 PATCH, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Notification Templates 20

Notification templates for customizing event notifications

GET
/v1/notificationTemplates
List notification templates
listNotificationTemplates 6 params → 200
PUT
/v1/notificationTemplates
Create or update a notification template
createOrUpdateNotificationTemplate body → 200400403
POST
/v1/notificationTemplates
Create a notification template
createNotificationTemplate body → 200400
GET
/v1/notificationTemplates/name/{fqn}
Get a notification template by fully qualified name
getNotificationTemplateByFQN 4 params → 200404
DELETE
/v1/notificationTemplates/name/{fqn}
Delete a notification template by fully qualified name
deleteNotificationTemplateByFQN 3 params → 200400404
PATCH
/v1/notificationTemplates/name/{fqn}
Update a notification template by name
patchNotificationTemplateByFQN 1 param body → 200400403404
GET
/v1/notificationTemplates/{id}
Get a notification template by Id
getNotificationTemplateById 4 params → 200404
DELETE
/v1/notificationTemplates/{id}
Delete a notification template by Id
deleteNotificationTemplate 3 params → 200400404
PATCH
/v1/notificationTemplates/{id}
Update a notification template
patchNotificationTemplate 1 param body → 200400403404
DELETE
/v1/notificationTemplates/async/{id}
Asynchronously delete a notification template by Id
deleteNotificationTemplateAsync 3 params → 200404
GET
/v1/notificationTemplates/helpers
Get available Handlebars helpers
getHandlebarsHelpers → 200
GET
/v1/notificationTemplates/{id}/versions/{version}
Get a version of the notification template
getSpecificNotificationTemplateVersion 2 params → 200404
GET
/v1/notificationTemplates/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_28 5 params → 200
GET
/v1/notificationTemplates/{id}/versions
List notification template versions
listAllNotificationTemplateVersions 1 param → 200
POST
/v1/notificationTemplates/render
Render notification template with mock data
renderNotificationTemplate body → 200400
PUT
/v1/notificationTemplates/name/{fqn}/reset
Reset a notification template to its default state by fully qualified name
resetNotificationTemplateByFQN 1 param → 200400403404
PUT
/v1/notificationTemplates/{id}/reset
Reset a notification template to its default state by Id
resetNotificationTemplateById 1 param → 200400403404
PUT
/v1/notificationTemplates/restore
Restore a soft deleted notification template
restore_20 body → 200
POST
/v1/notificationTemplates/send
Validate and send notification template to external destinations
sendNotificationTemplateTest body → 200400
POST
/v1/notificationTemplates/validate
Validate notification template syntax
validateNotificationTemplate body → 200400

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are NotificationTemplate (34 properties), TagLabel (13 properties), CreateNotificationTemplate (12 properties), SubscriptionDestination (10 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
TemplateRenderResult
object
2 properties 2 required
NotificationTemplateValidationResponse
object
3 properties 1 required
NotificationTemplateList
object
5 properties 1 required
CreateNotificationTemplate
object
12 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
RestoreEntity
object
1 property 1 required
CoverImage
object
2 properties
FieldChange
object
3 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
HandlebarsHelperMetadata
object
4 properties 3 required
JsonPatch
object
ChangeDescription
object
5 properties
NotificationTemplateValidationRequest
object
2 properties 2 required
NotificationTemplateSendRequest
object
2 properties 2 required
UsageStats
object
2 properties 1 required
SubscriptionDestination
object
10 properties 2 required
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
NotificationTemplateRenderRequest
object
4 properties 3 required
HandlebarsHelperUsage
object
2 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
NotificationTemplate
object
34 properties 4 required
NotificationTemplateRenderResponse
object
2 properties 1 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-notification-templates-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Notification Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.