Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a single workflow instance in the Workflow Space.

Hierarchy

  • WorkflowInstance

Index

Properties

adaptiveCardSchema?: WorkflowAdaptiveCardSchema

Adaptive card schema for the workflow ended card (used when endedCardType is ADAPTIVE_CARD). Contains the adaptive card object from the n-1 element of intentResponse array.

canRetry?: boolean

Whether retry is available for failed workflows

cognigySessionId?: string

Cognigy session ID for this workflow instance

completedAt?: string

Timestamp when workflow completed (if completed or failed)

contactId: string

Contact/case ID associated with this workflow

Conversation history with the workflow (for multi-turn interactions)

currentStep?: WorkflowStep

Current step information

currentStepIndex?: number

Index of the current step (0-based)

displayName: string

Display name for the workflow (intentTitle from WebSocket)

elapsedMilliseconds?: number

Elapsed time in milliseconds

endedCardDescription?: string

Text description for the workflow ended card (used when endedCardType is TEXT). Contains the text from the n-1 element of intentResponse array.

Card type for the workflow ended card (TEXT or ADAPTIVE_CARD). Determined from the n-1 element of intentResponse array.

errorMessage?: string

Error message if workflow failed

initiatedAt: string

Timestamp when workflow was initiated

insertIconVisible?: boolean

Whether the insert icon should be visible (true for digital)

instanceId: string

Unique identifier for the workflow instance

lastUpdatedAt: string

Timestamp of the last update

mediaType?: string

Media type - Digital or Voice

outputSummary?: string

Summary/output of the workflow (shown on completion)

results?: Record<string, unknown>

Key results or generated content from the workflow

sendIconVisible?: boolean

Whether the send icon should be visible (true for digital)

Current overall status of the workflow

taskSessionUid?: string

The original task session UID used to trigger this workflow. Kept constant for the lifetime of the session so all follow-up API calls (search bar, adaptive card submit) use the same GUID.

totalSteps?: number

Total number of steps in the workflow

workflowName: string

The workflow definition name

Generated using TypeDoc