> ## Documentation Index > Fetch the complete documentation index at: https://docs.occtoo.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a versioned event data schema > Returns the immutable JSON Schema for one event data payload version. Compatible additive changes receive a new minor version. Removing or renaming fields, changing a field type or meaning, or adding a required field receives a new major version. Documentation-only changes do not create a schema version. ## OpenAPI ````yaml /api-reference/openapi/events.json get /v1/events/schemas/{type}/{version} openapi: 3.1.1 info: title: Occtoo Events API description: >- Occtoo Events API exposes customer-safe CloudEvents derived from changes across an Occtoo tenant. Use pull for scheduled or batch processing and SSE for low-latency delivery. Both transports read the same ordered, 90-day retained event projection. ## Quick start 1. Select **Authorize** and sign in with the existing Occtoo identity, or provide a bearer token or organization API key. 2. Inspect the [event catalog](https://api.occtoo.com/v1/event-types) to select event types and entity-level filters. 3. Pull the first page, process it, and persist its `after` cursor. ```bash curl --get 'https://api.occtoo.com/v1/events' \ --header 'Authorization: Bearer ' \ --data-urlencode 'limit=100' \ --data-urlencode 'filter=type eq "source.updated" and sourceId eq "products"' ``` To check whether that consumer has reached the latest event matching the same filter, read stream metadata and compare `latest.sequence` with the last processed CloudEvent sequence. Sequence gaps identify position, not an exact number of pending matching events. ```bash curl --get 'https://api.occtoo.com/v1/events/metadata' \ --header 'Authorization: Bearer ' \ --data-urlencode 'filter=type eq "source.updated" and sourceId eq "products"' ``` ## Authentication and tenancy Event reads require a tenant-scoped credential. All delivery endpoints accept the established `read-events` permission. Tenant applications can instead use `events:pull` for pull and metadata or `events:sse` for SSE. Interactive user calls use Authorization Code with PKCE and can reuse the existing Occtoo sign-in session. Machine consumers can send a tenant-scoped Kinde application token as `Authorization: Bearer ` or an Occtoo organization API key as `x-api-key: `. The gateway validates the credential, projects application scopes directly as permissions, and supplies its tenant and actor identity to the Events API; the tenant cannot be selected with a query parameter. Native browser `EventSource` cannot attach either authorization header. Browser applications should consume SSE with streaming `fetch` or relay it through an authenticated backend; server-side SSE clients can set either header directly. ## Delivery and checkpoints Events are ordered by the fixed-width `sequence` extension rather than their timestamp. A new SSE connection without a cursor starts live at the current tenant-stream tail; it does not replay retained history. Pull normally transports a position as an opaque `after` cursor, but accepts the raw sequence as a recovery checkpoint when the cursor was not retained. SSE transports the raw sequence as `Last-Event-ID`. Resuming is exclusive: the event at the supplied position is not delivered again. Public event ids are deterministic UUIDv5 values, so replaying the same internal event recreates the same id. Consumers should nevertheless make business processing idempotent and checkpoint only after successful processing. ### Recover from a recorded sequence If the returned pull cursor was lost but the last successfully processed CloudEvent `sequence` was retained, pass that sequence directly as `after`. Continue using the same filter as the original subscription. ```bash curl --get 'https://api.occtoo.com/v1/events' \ --header 'Authorization: Bearer ' \ --data-urlencode 'after=003.00000000000000184467' \ --data-urlencode 'filter=type eq "source.updated" and sourceId eq "products"' ``` To resume SSE from the same processed position, send `Last-Event-ID: 003.00000000000000184467`. The first event returned has a greater sequence. ## Filtering `filter` implements a bounded RFC 7644-derived subset: `eq`, `and`, `or`, parentheses and JSON double-quoted strings. `and` binds more tightly than `or`. Use parentheses when combining event families. Only `type` and the entity-level properties advertised by the catalog are accepted; entry/card-level filters are intentionally unavailable. ## Schema compatibility The CloudEvent `type` is stable and unversioned. Read the exact payload version from `dataschema`. A new minor version is additive: ignore unknown fields and fetch the new immutable schema asynchronously. Do not deserialize a new major version as an earlier major; retain or quarantine the raw event until the consumer is upgraded. Machine-readable contracts: [OpenAPI](https://api.occtoo.com/openapi/events.json) · [AsyncAPI](https://api.occtoo.com/asyncapi/events.json) · [event catalog](https://api.occtoo.com/v1/event-types) version: 1.0.0 summary: Pull, inspect and stream tenant-scoped Occtoo events. servers: - url: https://api.occtoo.com description: Occtoo public API security: [] tags: - name: Event delivery description: >- Consume the ordered tenant event feed by finite pull pages or a resumable SSE connection, and inspect retained filtered stream metadata. All operations use the same filter semantics. - name: Event discovery description: >- Discover stable event type names, available schema versions and the entity properties that can be filtered. - name: Event schemas description: >- Retrieve immutable JSON Schemas referenced by each CloudEvent `dataschema` attribute. externalDocs: description: AsyncAPI contract for the SSE channel and all event messages url: https://api.occtoo.com/asyncapi/events.json paths: /v1/events/schemas/{type}/{version}: get: tags: - Event schemas summary: Get a versioned event data schema description: >- Returns the immutable JSON Schema for one event data payload version. Compatible additive changes receive a new minor version. Removing or renaming fields, changing a field type or meaning, or adding a required field receives a new major version. Documentation-only changes do not create a schema version. operationId: GetPublicEventSchema parameters: - name: type in: path description: Stable event type from the event catalog. required: true schema: type: string example: source.updated - name: version in: path description: Payload schema version in `major.minor` form. required: true schema: type: string example: '1.0' responses: '200': description: The immutable JSON Schema for the requested event data payload. content: application/schema+json: schema: type: object description: A JSON Schema Draft 2020-12 document. examples: sourceUpdatedSchema: summary: source.updated data schema value: type: object properties: sourceId: type: string x-occtoo-filterable: true changes: type: array items: type: string properties: type: - array - 'null' items: type: object properties: id: type: string change: type: string required: - id - change default: null correlationIds: type: array items: type: string actor: type: - object - 'null' properties: id: type: string required: - id required: - sourceId - changes - correlationIds $schema: https://json-schema.org/draft/2020-12/schema $id: >- https://api.occtoo.com/v1/events/schemas/source.updated/1.0 additionalProperties: true '404': description: The event type or schema version is not in the public catalog. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: unknownSchema: summary: Unknown event schema value: message: Unknown event schema source.updated/2.0. components: schemas: ApiError: required: - message type: object properties: message: type: string ````