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 full)

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

userId: string

Optionaluser

user?: Customer

OptionalconnectionId

connectionId?: string

Optionalconnection

connection?: Connection

Optionalflow

flow?: Flow

OptionalflowId

flowId?: string

OptionaluniversalFlowId

universalFlowId?: string

integrationId

integrationId: string

Optionalintegration

integration?: Integration

OptionalinstanceKey

instanceKey?: string

Optionalparameters

parameters?: any

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

OptionalparametersSchema

parametersSchema?: DataSchema

Schema of parameters the flow accepts. Copied from FlowBlueprint

Optionalnodes

nodes?: Record<string, FlowInstanceNode>

Dictionary of flow's nodes: :

enabled

enabled: boolean

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

createdAt

createdAt: string

updatedAt

updatedAt: string

Optionalstate

state?: WorkspaceElementState

Optionaloutdated

outdated?: boolean

Optionalcustomized

customized?: {
    name?: boolean;
    nodes?: boolean;
}

customization details.

Type declaration

  • Optionalname?: boolean
  • Optionalnodes?: boolean

    added or removed nodes.

Optionaldependencies

dependencies?: IntegrationElementInstance[]

id

id: string

name

name: string

key

key: string

Optionalerrors

errors?: ErrorData[]

Settings

Member Visibility

On This Page

Properties