Interface Flow

interface Flow {
    id: string;
    name: string;
    key: string;
    integrationId?: string;
    integration?: Integration;
    universalFlowId?: string;
    universalFlowRevision?: string;
    parametersSchema?: DataSchema;
    nodes?: Record<string, FlowNode>;
    autoCreateInstances?: boolean;
    archivedAt?: string;
    revision: string;
    customized?: boolean;
    appliedToIntegrations?: AppliedToIntegrations<Flow>;
    isDeployed?: boolean;
}

Properties

id name key integrationId? integration? universalFlowId? universalFlowRevision? parametersSchema? nodes? autoCreateInstances? archivedAt? revision customized? appliedToIntegrations? isDeployed?

Properties

id

id: string

Flow's unique id. It never changes.

name

name: string

Human-readable name of the flow

key

key: string

Developer-friendly key the flow can be addressed by. Must be unique among all published flows within an app.

OptionalintegrationId

integrationId?: string

Integration this flow belongs to.

Optionalintegration

integration?: Integration

OptionaluniversalFlowId

universalFlowId?: string

OptionaluniversalFlowRevision

universalFlowRevision?: string

OptionalparametersSchema

parametersSchema?: DataSchema

DataSchema of parameters provided during the flow creation. Can be used to configure the flow logic.

Optionalnodes

nodes?: Record<string, FlowNode>

Flow Nodes in the format :

OptionalautoCreateInstances

autoCreateInstances?: boolean

Automatically create a Flow Instance when a Connection is created.

OptionalarchivedAt

archivedAt?: string

If a flow was archived - the time it was archived at in the ISO format.

revision

revision: string

Optionalcustomized

customized?: boolean

OptionalappliedToIntegrations

appliedToIntegrations?: AppliedToIntegrations<Flow>

OptionalisDeployed

isDeployed?: boolean

Settings

Member Visibility

On This Page

Properties