Interface: AnnotateAttachInput

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

Input for the public kernel.annotations.attach helper.

Properties

actor?

optional actor?: AnnotationActor

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

---

attempt?

optional attempt?: number

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

---

attributes

attributes: Record<string, unknown>

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

---

emitEvent?

optional emitEvent?: boolean

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

If true, the engine writes an annotation:created outbox event for each attribute in this batch, in the same transaction as the annotation rows. Off by default.

---

idempotencyKey?

optional idempotencyKey?: string

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

---

payload?

optional payload?: Record<string, unknown>

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

---

scope?

optional scope?: AnnotationScope

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

Defaults to "run". Set to "stage" with scopeId to scope an annotation to a specific stage (e.g., from a plugin observing stage events).

---

scopeId?

optional scopeId?: string | null

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

---

workflowStageRecordId?

optional workflowStageRecordId?: string | null

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