Interface WorkflowTaskUpdate

Atomic update payload for a task within a workflow.

interface WorkflowTaskUpdate {
    taskId: string;
    status?: WorkflowTaskStatus;
    assignedExecutorId?: string;
    startedAt?: string;
    completedAt?: string;
    output?: unknown;
    error?: null | {
        message: string;
        code?: string;
        details?: unknown;
    };
    metadata?: Record<string, unknown>;
}

Properties

taskId status? assignedExecutorId? startedAt? completedAt? output? error? metadata?

Properties

taskId

taskId: string

Optional status

status?: WorkflowTaskStatus

Optional assignedExecutorId

assignedExecutorId?: string

Optional startedAt

startedAt?: string

Optional completedAt

completedAt?: string

Optional output

output?: unknown

Optional error

error?: null | {
    message: string;
    code?: string;
    details?: unknown;
}

Type declaration

  • message: string
  • Optional code?: string
  • Optional details?: unknown

Optional metadata

metadata?: Record<string, unknown>

Settings

Member Visibility

Theme

On This Page

taskIdstatusassignedExecutorIdstartedAtcompletedAtoutputerrormetadata