Skip to content
v9.1.1
Français

WorkflowInputRequest

import type { WorkflowInputRequest } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • idRequired
    string
    Unique identifier of this persisted question, required when submitting its answer.
  • executionIdRequired
    string
    Workflow execution owning this pending request.
  • keyRequired
    string
    Key of the task suspended on this request.
  • requestedAtRequired
    string
    ISO timestamp when the question was created.
  • questionRequired
    string
    Nonempty human-readable question to display to the respondent.
  • choicesOptional
    readonly string[] | undefined
    Nonempty list of unique answer choices.
  • allowFreeTextOptional
    boolean | undefined
    Whether answers outside choices are accepted; omitted means true. False requires choices.

Signature

Section titled “Signature”
export interface WorkflowInputRequest extends WorkflowInputQuestion {
  readonly id: string;
  readonly executionId: string;
  readonly key: string;
  readonly requestedAt: string;
}
Section titled “Related contracts”