Interface FlowInstance

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

Properties

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

Properties

id

id: string

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

name

name: string

This flow's unique user-readable name.

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

Optionaldependencies

dependencies?: IntegrationElementInstance[]

List of dependencies.

Optionalstate

state?: WorkspaceElementState

Optionaloutdated

outdated?: boolean

Optionalcustomized

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

customization details.

Type declaration

  • Optionalname?: boolean
  • Optionalnodes?: boolean

    added or removed nodes.

Settings

Member Visibility

On This Page

Properties