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 Events API

The `Events` are changes to metadata and are sent when entities are created, modified, or updated. External systems can subscribe to events using event subscription API over Webhooks, Slack, or Microsoft Teams.

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

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

This API exposes 31 operations across 27 paths, and defines 45 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.

31 operations 27 paths 45 schemas 3 DELETE22 GET2 PATCH2 POST2 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 Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 31

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

Events 31

The Events are changes to metadata and are sent when entities are created, modified, or updated. External systems can subscribe to events using event subscription API over Webhook…

GET
/v1/events
Get change events
listChangeEvents 5 params → 200404
GET
/v1/events/subscriptions/{id}/processedEvents
Check If the Publisher Processed All Events
checkIfThePublisherProcessedALlEvents 1 param → 200
GET
/v1/events/subscriptions
List all available Event Subscriptions
listEventSubscriptions 6 params → 200
PUT
/v1/events/subscriptions
Updated an existing or create a new Event Subscription
createOrUpdateEventSubscription body → 200400
POST
/v1/events/subscriptions
Create a new Event Subscription
createEventSubscription body → 200400
GET
/v1/events/subscriptions/{id}
Get a event Subscription by ID
getEventSubscriptionByID 2 params → 200404
DELETE
/v1/events/subscriptions/{id}
Delete an Event Subscription by Id
deleteEventSubscription 1 param → 200404
PATCH
/v1/events/subscriptions/{id}
Update an Event Subscriptions
patchEventSubscription_1 1 param body → default
DELETE
/v1/events/subscriptions/async/{id}
Asynchronously delete an Event Subscription by Id
deleteEventSubscriptionAsync 1 param → 200404
DELETE
/v1/events/subscriptions/name/{name}
Delete an Event Subscription by name
deleteEventSubscriptionByName 1 param → 200404
GET
/v1/events/subscriptions/id/{eventSubscriptionId}/destinations
Get the destinations for a specific Event Subscription
getAllDestinationForEventSubscription 1 param → 200404
GET
/v1/events/subscriptions/name/{eventSubscriptionName}/destinations
Get the destinations for a specific Event Subscription by its name
getAllDestinationForEventSubscriptionByName 1 param → 200404
GET
/v1/events/subscriptions/listAllFailedEvents
Get all failed events
getAllFailedEvents 3 params → 200500
GET
/v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo
Get event subscription diagnostic info
getEventSubscriptionDiagnosticInfoById 4 params → 200404500
GET
/v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo
Get event subscription diagnostic info by name
getEventSubscriptionDiagnosticInfoByName 4 params → 200404500
GET
/v1/events/subscriptions/id/{subscriptionId}/eventsRecord
Get event subscription events record
getEventSubscriptionEventsRecordById 1 param → 200404500
GET
/v1/events/subscriptions/name/{subscriptionName}/eventsRecord
Get event subscription events record by name
getEventSubscriptionEventsRecordByName 1 param → 200404500
GET
/v1/events/subscriptions/{eventSubscriptionId}/status/{destinationId}
Get Event Subscription status by Id
getEventSubscriptionStatusById 2 params → 200404
GET
/v1/events/subscriptions/name/{eventSubscriptionName}/status/{destinationId}
Get Event Subscription status
getEventSubscriptionStatus 2 params → 200404
GET
/v1/events/subscriptions/{id}/versions/{version}
Get a version of the Event Subscription
getSpecificEventSubscriptionVersion 2 params → 200404
GET
/v1/events/subscriptions/id/{id}/listEvents
Retrieve events based on various filters
getEvents 4 params → 200404400500
GET
/v1/events/subscriptions/name/{eventSubscriptionName}
Get an Event Subscription by name
getEventSubscriptionByName 2 params → 200404
GET
/v1/events/subscriptions/id/{id}/failedEvents
Get failed events for a subscription by id
getFailedEventsBySubscriptionId 4 params → 200404500
GET
/v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents
Get failed events for a subscription by name
getFailedEventsBySubscriptionName 4 params → 200404500
GET
/v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents
Get successfully sent change events for an alert
getSuccessfullySentChangeEventsForAlert 3 params → 200404500
GET
/v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents
Get successfully sent change events for an alert by name
getSuccessfullySentChangeEventsForAlertByName 3 params → 200404500
GET
/v1/events/subscriptions/{alertType}/resources
Get list of Event Subscriptions Resources used in filtering Event Subscription
listEventSubscriptionResources 1 param → default
GET
/v1/events/subscriptions/{id}/versions
List Event Subscription versions
listAllEventSubscriptionVersion 1 param → 200
PATCH
/v1/events/subscriptions/name/{fqn}
Update an Event Subscriptions by name.
patchEventSubscription 1 param body → default
POST
/v1/events/subscriptions/testDestination
Send a test message alert to external destinations.
testDestination body → 200
PUT
/v1/events/subscriptions/name/{eventSubscriptionName}/syncOffset
Sync Offset for a specific Event Subscription by its name
syncOffsetForEventSubscriptionByName 1 param → 200404

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are EventSubscription (43 properties), CreateEventSubscription (23 properties), Response (17 properties), ChangeEvent (14 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ResultListFilterResourceDescriptor
object
5 properties 1 required
StatusType
object
3 properties
CreateEventSubscription
object
23 properties 2 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
Response
object
17 properties
FieldChange
object
3 properties
Link
object
7 properties
CoverImage
object
2 properties
EventFilterRule
object
9 properties 2 required
LifeCycle
object
3 properties
TriggerConfig
object
3 properties 1 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
FilteringRules
object
3 properties 1 required
EventSubscriptionDiagnosticInfo
object
10 properties
Paging
object
5 properties 1 required
UriBuilder
object
EventsRecord
object
4 properties
JsonPatch
object
ChangeDescription
object
5 properties
NewCookie
object
11 properties
SubscriptionStatus
object
7 properties
EventSubscription
object
43 properties 4 required
AlertFilteringInput
object
2 properties
MediaType
object
5 properties
ArgumentsInput
object
4 properties
Argument
object
2 properties
EventSubscriptionList
object
5 properties 1 required
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
SubscriptionDestination
object
10 properties 2 required
Style
object
3 properties
Votes
object
4 properties
EntityTag
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
FilterResourceDescriptor
object
3 properties
EventList
object
5 properties 1 required
EntityReference
object
9 properties 2 required
EventSubscriptionDestinationTestRequest
object
1 property
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-events-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 Events 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.