# Collate Events API

**Canonical:** https://apis.io/apis/collate/collate-events-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Events API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://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 an API reference.

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.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/events` | Get change events |
| GET | `/v1/events/subscriptions/{id}/processedEvents` | Check If the Publisher Processed All Events |
| GET | `/v1/events/subscriptions` | List all available Event Subscriptions |
| PUT | `/v1/events/subscriptions` | Updated an existing or create a new Event Subscription |
| POST | `/v1/events/subscriptions` | Create a new Event Subscription |
| GET | `/v1/events/subscriptions/{id}` | Get a event Subscription by ID |
| DELETE | `/v1/events/subscriptions/{id}` | Delete an Event Subscription by Id |
| PATCH | `/v1/events/subscriptions/{id}` | Update an Event Subscriptions |
| DELETE | `/v1/events/subscriptions/async/{id}` | Asynchronously delete an Event Subscription by Id |
| DELETE | `/v1/events/subscriptions/name/{name}` | Delete an Event Subscription by name |
| GET | `/v1/events/subscriptions/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/events/subscriptions/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/events/subscriptions/id/{eventSubscriptionId}/destinations` | Get the destinations for a specific Event Subscription |
| GET | `/v1/events/subscriptions/name/{eventSubscriptionName}/destinations` | Get the destinations for a specific Event Subscription by its name |
| GET | `/v1/events/subscriptions/listAllFailedEvents` | Get all failed events |
| GET | `/v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo` | Get event subscription diagnostic info |
| GET | `/v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo` | Get event subscription diagnostic info by name |
| GET | `/v1/events/subscriptions/id/{subscriptionId}/eventsRecord` | Get event subscription events record |
| GET | `/v1/events/subscriptions/name/{subscriptionName}/eventsRecord` | Get event subscription events record by name |
| GET | `/v1/events/subscriptions/{eventSubscriptionId}/status/{destinationId}` | Get Event Subscription status by Id |
| GET | `/v1/events/subscriptions/name/{eventSubscriptionName}/status/{destinationId}` | Get Event Subscription status |
| GET | `/v1/events/subscriptions/{id}/versions/{version}` | Get a version of the Event Subscription |
| GET | `/v1/events/subscriptions/id/{id}/listEvents` | Retrieve events based on various filters |
| GET | `/v1/events/subscriptions/name/{eventSubscriptionName}` | Get an Event Subscription by name |
| GET | `/v1/events/subscriptions/id/{id}/failedEvents` | Get failed events for a subscription by id |
| GET | `/v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents` | Get failed events for a subscription by name |
| GET | `/v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents` | Get successfully sent change events for an alert |
| GET | `/v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents` | Get successfully sent change events for an alert by name |
| GET | `/v1/events/subscriptions/{alertType}/resources` | Get list of Event Subscriptions Resources used in filtering Event Subscription |
| GET | `/v1/events/subscriptions/{id}/versions` | List Event Subscription versions |
| PATCH | `/v1/events/subscriptions/name/{fqn}` | Update an Event Subscriptions by name |
| POST | `/v1/events/subscriptions/testDestination` | Send a test message alert to external destinations |
| PUT | `/v1/events/subscriptions/name/{eventSubscriptionName}/syncOffset` | Sync Offset for a specific Event Subscription by its name |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-events-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Event

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-events-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.