ping-identity
    Preparing search index...

    Type Alias JourneyBaseField

    Base shape shared by all normalized callback fields.

    raw is the original native callback payload and serves as the escape hatch to access any field not surfaced by the specific field type.

    Use field.type (shorthand for field.ref.type) as the discriminant to narrow to a specific field subtype.

    type JourneyBaseField = {
        defaultValue?: JourneyFormValue;
        executionMode: JourneyExecutionMode;
        id: string;
        kind: JourneyFieldKind;
        message?: string;
        options?: JourneyFieldOption[];
        prompt: string;
        raw: JourneyCallback;
        ref: JourneyFieldRef;
        required: boolean;
        requiresUserInput: boolean;
        type: JourneyCallbackType;
    }
    Index

    Properties

    defaultValue? executionMode id kind message? options? prompt raw ref required requiresUserInput type

    Properties

    defaultValue?: JourneyFormValue

    Optional default value derived from callback payload.

    executionMode: JourneyExecutionMode

    Execution mode classification for submit behavior.

    id: string

    Stable internal field key.

    Treat this as an opaque identifier and do not rely on its string format.

    kind: JourneyFieldKind

    UI-oriented field kind.

    message?: string

    Optional callback message value.

    options?: JourneyFieldOption[]

    Option collection for choice/confirmation callbacks.

    prompt: string

    Prompt text provided by the native callback payload.

    This value may be empty when the callback does not provide a prompt.

    raw: JourneyCallback

    Original native callback payload (escape hatch).

    ref: JourneyFieldRef

    Typed callback reference for this field.

    required: boolean

    Indicates whether this callback is marked as required by callback payload.

    requiresUserInput: boolean

    Indicates whether user interaction is required before submission.

    type: JourneyCallbackType

    Callback type shorthand — equivalent to ref.type.

    Use this as the discriminant to narrow the field to a specific subtype.

    Settings

    Member Visibility

    On This Page

    Properties