Integration App SDK - v1.14.0
    Preparing search index...

    Interface FlowInstance

    interface FlowInstance {
        userId: string;
        user?: Customer;
        connectionId?: string;
        connection?: Connection;
        flow?: Flow;
        flowId?: string;
        universalFlowId?: string;
        integrationId: string;
        integration?: Integration;
        instanceKey?: string;
        parameters?: any;
        parametersSchema?: DataSchema;
        nodes?: Record<string, FlowInstanceNode>;
        enabled: boolean;
        createdAt: string;
        updatedAt: string;
        state?: WorkspaceElementState;
        outdated?: boolean;
        customized?: { name?: boolean; nodes?: boolean };
        dependencies?: IntegrationElementInstance[];
        id: string;
        name: string;
        key: string;
        errors?: ErrorData[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    userId user? connectionId? connection? flow? flowId? universalFlowId? integrationId integration? instanceKey? parameters? parametersSchema? nodes? enabled createdAt updatedAt state? outdated? customized? dependencies? id name key errors?

    Properties

    userId: string
    user?: Customer
    connectionId?: string
    connection?: Connection
    flow?: Flow
    flowId?: string
    universalFlowId?: string
    integrationId: string
    integration?: Integration
    instanceKey?: string
    parameters?: any

    This flow's parameters. Can be used as variables in nodes.

    parametersSchema?: DataSchema

    Schema of parameters the flow accepts. Copied from FlowBlueprint

    nodes?: Record<string, FlowInstanceNode>

    Dictionary of flow's nodes: :

    enabled: boolean

    Whether the flow is enabled (i.e. triggers are active)

    createdAt: string
    updatedAt: string
    state?: WorkspaceElementState
    outdated?: boolean
    customized?: { name?: boolean; nodes?: boolean }

    customization details.

    Type declaration

    • Optionalname?: boolean
    • Optionalnodes?: boolean

      added or removed nodes.

    dependencies?: IntegrationElementInstance[]
    id: string
    name: string
    key: string
    errors?: ErrorData[]

    Settings

    Member Visibility

    On This Page

    Properties