ClientResponseOption

Interface

Description

The interface for client response option object. Use this object to submit client input to the Journey step to process, cancel the current step or choose a custom branch.

Properties

type

• Readonly type: ClientResponseOptionType

Description

The type of the client response option.

id

• Readonly id: string

Description

The id of the client response option. Journey step unique id is provided for the Custom response option type. ClientInput and Cancel have standard Ids ClientInput and Cancel, respectively.

label

• Readonly label: string

Description

The label of the client response option.

schema

• Optional schema: Record<string, any>

Description

Optional schema object that can be used for UI rendering.