Skip to content

@oneplatform/sdk


@oneplatform/sdk / PlatformEvent

Interface: PlatformEvent

Defined in: packages/sdk/src/types/subscription.ts:8

Properties

id

readonly id: string

Defined in: packages/sdk/src/types/subscription.ts:10

Unique event ID. Used as Last-Event-ID for stream resumption.


occurredAt

readonly occurredAt: string

Defined in: packages/sdk/src/types/subscription.ts:19

ISO 8601 timestamp when the event occurred on the server.


payload

readonly payload: unknown

Defined in: packages/sdk/src/types/subscription.ts:22

Event-specific payload. Type varies by event type.


tenantId

readonly tenantId: string

Defined in: packages/sdk/src/types/subscription.ts:16

Tenant this event belongs to.


type

readonly type: string

Defined in: packages/sdk/src/types/subscription.ts:13

Dot-separated event type hierarchy. E.g. "pipeline.run.completed"