Skip to main content

Interface: AnnotationCreatedEvent

Defined in: packages/workflow-engine/src/kernel/events.ts:161

Emitted when an annotation is written with emitEvent: true. Lets plugins and external systems react to provenance writes in real time (audit pipelines, SIEM, live dashboards) without polling kernel.annotations.list.

Off by default — annotations are primarily a queryable provenance surface, not an event stream. Most consumers won't need this.

Properties​

actorId?​

readonly optional actorId?: string

Defined in: packages/workflow-engine/src/kernel/events.ts:171


actorKind?​

readonly optional actorKind?: string

Defined in: packages/workflow-engine/src/kernel/events.ts:170


actorVersion?​

readonly optional actorVersion?: string

Defined in: packages/workflow-engine/src/kernel/events.ts:172


attempt?​

readonly optional attempt?: number

Defined in: packages/workflow-engine/src/kernel/events.ts:169


key​

readonly key: string

Defined in: packages/workflow-engine/src/kernel/events.ts:165


scope​

readonly scope: string

Defined in: packages/workflow-engine/src/kernel/events.ts:167


scopeId?​

readonly optional scopeId?: string

Defined in: packages/workflow-engine/src/kernel/events.ts:168


timestamp​

readonly timestamp: Date

Defined in: packages/workflow-engine/src/kernel/events.ts:163


type​

readonly type: "annotation:created"

Defined in: packages/workflow-engine/src/kernel/events.ts:162


value​

readonly value: unknown

Defined in: packages/workflow-engine/src/kernel/events.ts:166


workflowRunId​

readonly workflowRunId: string

Defined in: packages/workflow-engine/src/kernel/events.ts:164