Variable FlowApiResponse`Const`

FlowApiResponse: ZodObject<
    {
        integration: ZodOptional<
            ZodObject<
                {
                    logoUri: ZodString;
                    connectorId: ZodOptional<ZodString>;
                    connectorVersion: ZodOptional<ZodString>;
                    oAuthCallbackUri: ZodOptional<ZodString>;
                    parameters: ZodOptional<ZodAny>;
                    archivedAt: ZodOptional<ZodString>;
                    hasMissingParameters: ZodOptional<ZodBoolean>;
                    hasDocumentation: ZodOptional<ZodBoolean>;
                    hasOperations: ZodOptional<ZodBoolean>;
                    operationsCount: ZodOptional<ZodNumber>;
                    hasData: ZodOptional<ZodBoolean>;
                    dataCollectionsCount: ZodOptional<ZodNumber>;
                    hasEvents: ZodOptional<ZodBoolean>;
                    eventsCount: ZodOptional<ZodNumber>;
                    hasGlobalWebhooks: ZodOptional<ZodBoolean>;
                    hasUdm: ZodOptional<ZodBoolean>;
                    isTest: ZodOptional<ZodBoolean>;
                    externalAppId: ZodOptional<ZodString>;
                    appUuid: ZodOptional<ZodString>;
                    isDeactivated: ZodOptional<ZodBoolean>;
                    authType: ZodOptional<
                        ZodEnum<
                            {
                                proxy: "proxy";
                                "integration-app-token": "integration-app-token";
                                "membrane-token": "membrane-token";
                                oauth2: "oauth2";
                                oauth1: "oauth1";
                                "client-credentials": "client-credentials";
                            },
                        >,
                    >;
                    optionsConfig: ZodOptional<
                        ZodRecord<
                            ZodString,
                            ZodObject<
                                {
                                    disabled: ZodOptional<ZodBoolean>;
                                    parameters: ZodOptional<ZodRecord<(...), (...)>>;
                                },
                                $strip,
                            >,
                        >,
                    >;
                    id: ZodString;
                    uuid: ZodOptional<ZodString>;
                    key: ZodOptional<ZodString>;
                    description: ZodOptional<ZodString>;
                    meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    name: ZodString;
                    state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
                    errors: ZodOptional<
                        ZodArray<
                            ZodType<
                                ErrorDataSchema,
                                unknown,
                                $ZodTypeInternals<ErrorDataSchema, unknown>,
                            >,
                        >,
                    >;
                    revision: ZodOptional<ZodString>;
                    createdAt: ZodOptional<ZodString>;
                    updatedAt: ZodOptional<ZodString>;
                    isReadOnly: ZodOptional<ZodBoolean>;
                },
                $strip,
            >,
        >;
        appliedToIntegrations: ZodOptional<
            ZodArray<
                ZodObject<
                    {
                        element: ZodObject<
                            {
                                connectionId: ZodOptional<ZodString>;
                                instanceKey: ZodOptional<ZodString>;
                                flowId: ZodOptional<ZodString>;
                                universalFlowId: ZodOptional<ZodString>;
                                parametersSchema: ZodOptional<
                                    ZodType<DataSchema, unknown, $ZodTypeInternals<(...), (...)>>,
                                >;
                                parameters: ZodOptional<ZodAny>;
                                enabled: ZodOptional<ZodBoolean>;
                                nodes: ZodOptional<ZodRecord<ZodString, ZodObject<(...), (...)>>>;
                                autoCreateInstances: ZodOptional<ZodBoolean>;
                                flowRevision: ZodOptional<ZodString>;
                                universalFlowRevision: ZodOptional<ZodString>;
                                createdAt: ZodOptional<ZodString>;
                                updatedAt: ZodOptional<ZodString>;
                                state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
                                customized: ZodOptional<
                                    ZodObject<{ name: ...; nodes: ... }, $strip>,
                                >;
                                dependencies: ZodOptional<ZodArray<ZodAny>>;
                                id: ZodString;
                                uuid: ZodOptional<ZodString>;
                                key: ZodOptional<ZodString>;
                                description: ZodOptional<ZodString>;
                                meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                                name: ZodString;
                                errors: ZodOptional<ZodArray<ZodType<(...), (...), (...)>>>;
                                revision: ZodOptional<ZodString>;
                                archivedAt: ZodOptional<ZodString>;
                                isDeactivated: ZodOptional<ZodBoolean>;
                                isReadOnly: ZodOptional<ZodBoolean>;
                                integrationId: ZodOptional<ZodString>;
                                integrationUuid: ZodOptional<ZodString>;
                                integrationKey: ZodOptional<ZodString>;
                                parentUuid: ZodOptional<ZodString>;
                                parentKey: ZodOptional<ZodString>;
                                isUniversal: ZodOptional<ZodBoolean>;
                                externalAppId: ZodOptional<ZodString>;
                                externalAppUuid: ZodOptional<ZodString>;
                                externalAppKey: ZodOptional<ZodString>;
                                isCustomized: ZodOptional<ZodBoolean>;
                                userId: ZodOptional<ZodString>;
                                tenantId: ZodOptional<ZodOptional<ZodString>>;
                            },
                            $strip,
                        >;
                        integration: ZodObject<
                            {
                                logoUri: ZodString;
                                connectorId: ZodOptional<ZodString>;
                                connectorVersion: ZodOptional<ZodString>;
                                oAuthCallbackUri: ZodOptional<ZodString>;
                                parameters: ZodOptional<ZodAny>;
                                archivedAt: ZodOptional<ZodString>;
                                hasMissingParameters: ZodOptional<ZodBoolean>;
                                hasDocumentation: ZodOptional<ZodBoolean>;
                                hasOperations: ZodOptional<ZodBoolean>;
                                operationsCount: ZodOptional<ZodNumber>;
                                hasData: ZodOptional<ZodBoolean>;
                                dataCollectionsCount: ZodOptional<ZodNumber>;
                                hasEvents: ZodOptional<ZodBoolean>;
                                eventsCount: ZodOptional<ZodNumber>;
                                hasGlobalWebhooks: ZodOptional<ZodBoolean>;
                                hasUdm: ZodOptional<ZodBoolean>;
                                isTest: ZodOptional<ZodBoolean>;
                                externalAppId: ZodOptional<ZodString>;
                                appUuid: ZodOptional<ZodString>;
                                isDeactivated: ZodOptional<ZodBoolean>;
                                authType: ZodOptional<
                                    ZodEnum<
                                        {
                                            proxy: ...;
                                            "integration-app-token": ...;
                                            "membrane-token": ...;
                                            oauth2: ...;
                                            oauth1: ...;
                                            "client-credentials": ...;
                                        },
                                    >,
                                >;
                                optionsConfig: ZodOptional<
                                    ZodRecord<ZodString, ZodObject<(...), (...)>>,
                                >;
                                id: ZodString;
                                uuid: ZodOptional<ZodString>;
                                key: ZodOptional<ZodString>;
                                description: ZodOptional<ZodString>;
                                meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                                name: ZodString;
                                state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
                                errors: ZodOptional<ZodArray<ZodType<(...), (...), (...)>>>;
                                revision: ZodOptional<ZodString>;
                                createdAt: ZodOptional<ZodString>;
                                updatedAt: ZodOptional<ZodString>;
                                isReadOnly: ZodOptional<ZodBoolean>;
                            },
                            $strip,
                        >;
                    },
                    $strip,
                >,
            >,
        >;
        user: ZodOptional<
            ZodObject<
                {
                    id: ZodString;
                    name: ZodString;
                    meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    internalId: ZodString;
                    fields: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    credentials: ZodOptional<ZodAny>;
                    lastActiveAt: ZodOptional<ZodString>;
                    isTest: ZodOptional<ZodBoolean>;
                    isBillable: ZodOptional<ZodBoolean>;
                    isActive: ZodOptional<ZodBoolean>;
                    aiCreditsRolling30DayLimit: ZodOptional<ZodNullable<ZodNumber>>;
                    createdAt: ZodOptional<ZodString>;
                    archivedAt: ZodOptional<ZodString>;
                },
                $strip,
            >,
        >;
        connection: ZodOptional<
            ZodObject<
                {
                    type: ZodOptional<ZodEnum<{ connector: "connector"; mcp: "mcp" }>>;
                    name: ZodString;
                    key: ZodOptional<ZodString>;
                    isTest: ZodOptional<ZodBoolean>;
                    connected: ZodOptional<ZodBoolean>;
                    disconnected: ZodOptional<ZodBoolean>;
                    isDefunct: ZodOptional<ZodBoolean>;
                    state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
                    errors: ZodOptional<
                        ZodArray<
                            ZodType<
                                ErrorDataSchema,
                                unknown,
                                $ZodTypeInternals<ErrorDataSchema, unknown>,
                            >,
                        >,
                    >;
                    requestError: ZodOptional<
                        ZodType<
                            ErrorDataSchema,
                            unknown,
                            $ZodTypeInternals<ErrorDataSchema, unknown>,
                        >,
                    >;
                    error: ZodOptional<
                        ZodType<
                            ErrorDataSchema,
                            unknown,
                            $ZodTypeInternals<ErrorDataSchema, unknown>,
                        >,
                    >;
                    integrationId: ZodOptional<ZodString>;
                    connectorId: ZodOptional<ZodString>;
                    externalAppId: ZodOptional<ZodString>;
                    connectorVersion: ZodOptional<ZodString>;
                    authOptionKey: ZodOptional<ZodString>;
                    createdAt: ZodString;
                    updatedAt: ZodString;
                    lastActiveAt: ZodOptional<ZodString>;
                    nextCredentialsRefreshAt: ZodOptional<ZodString>;
                    nextRetryTimestamp: ZodOptional<ZodString>;
                    retryAttempts: ZodOptional<ZodNumber>;
                    canTest: ZodOptional<ZodBoolean>;
                    canRefreshCredentials: ZodOptional<ZodBoolean>;
                    archivedAt: ZodOptional<ZodString>;
                    isDeactivated: ZodOptional<ZodBoolean>;
                    meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    buildingAgentSessionId: ZodOptional<ZodString>;
                    clientAction: ZodOptional<
                        ZodObject<
                            {
                                type: ZodEnum<
                                    { connect: "connect"; "provide-input": "provide-input" },
                                >;
                                description: ZodString;
                                uiUrl: ZodOptional<ZodString>;
                                agentInstructions: ZodOptional<ZodString>;
                                handoffAgentInstructions: ZodOptional<ZodString>;
                                reason: ZodOptional<
                                    ZodEnum<
                                        {
                                            "provide-input": ...;
                                            authenticate: ...;
                                            reauthenticate: ...;
                                        },
                                    >,
                                >;
                            },
                            $strip,
                        >,
                    >;
                    id: ZodString;
                    userId: ZodString;
                    tenantId: ZodOptional<ZodString>;
                },
                $strip,
            >,
        >;
        flow: ZodOptional<
            ZodObject<
                {
                    connectionId: ZodOptional<ZodString>;
                    instanceKey: ZodOptional<ZodString>;
                    flowId: ZodOptional<ZodString>;
                    universalFlowId: ZodOptional<ZodString>;
                    parametersSchema: ZodOptional<
                        ZodType<
                            DataSchema,
                            unknown,
                            $ZodTypeInternals<DataSchema, unknown>,
                        >,
                    >;
                    parameters: ZodOptional<ZodAny>;
                    enabled: ZodOptional<ZodBoolean>;
                    nodes: ZodOptional<
                        ZodRecord<
                            ZodString,
                            ZodObject<
                                {
                                    type: ZodOptional<ZodString>;
                                    version: ZodOptional<ZodNumber>;
                                    name: ZodOptional<ZodString>;
                                    description: ZodOptional<ZodString>;
                                    config: ZodOptional<ZodAny>;
                                    concurrency: ZodOptional<ZodNumber>;
                                    onError: ZodOptional<ZodEnum<(...)>>;
                                    ui: ZodOptional<ZodAny>;
                                    inputSchema: ZodOptional<ZodAny>;
                                    outputSchema: ZodOptional<ZodAny>;
                                    outputExample: ZodOptional<ZodAny>;
                                    links: ZodOptional<ZodArray<(...)>>;
                                    isCustomized: ZodOptional<ZodBoolean>;
                                    state: ZodOptional<ZodEnum<(...)>>;
                                    errors: ZodOptional<ZodArray<(...)>>;
                                    userConfig: ZodOptional<ZodAny>;
                                    testInput: ZodOptional<ZodAny>;
                                    dependencies: ZodOptional<ZodArray<(...)>>;
                                },
                                $strip,
                            >,
                        >,
                    >;
                    autoCreateInstances: ZodOptional<ZodBoolean>;
                    flowRevision: ZodOptional<ZodString>;
                    universalFlowRevision: ZodOptional<ZodString>;
                    createdAt: ZodOptional<ZodString>;
                    updatedAt: ZodOptional<ZodString>;
                    state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
                    customized: ZodOptional<
                        ZodObject<
                            { name: ZodOptional<ZodBoolean>; nodes: ZodOptional<ZodBoolean> },
                            $strip,
                        >,
                    >;
                    dependencies: ZodOptional<ZodArray<ZodAny>>;
                    id: ZodString;
                    uuid: ZodOptional<ZodString>;
                    key: ZodOptional<ZodString>;
                    description: ZodOptional<ZodString>;
                    meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
                    name: ZodString;
                    errors: ZodOptional<
                        ZodArray<
                            ZodType<
                                ErrorDataSchema,
                                unknown,
                                $ZodTypeInternals<ErrorDataSchema, unknown>,
                            >,
                        >,
                    >;
                    revision: ZodOptional<ZodString>;
                    archivedAt: ZodOptional<ZodString>;
                    isDeactivated: ZodOptional<ZodBoolean>;
                    isReadOnly: ZodOptional<ZodBoolean>;
                    integrationId: ZodOptional<ZodString>;
                    integrationUuid: ZodOptional<ZodString>;
                    integrationKey: ZodOptional<ZodString>;
                    parentUuid: ZodOptional<ZodString>;
                    parentKey: ZodOptional<ZodString>;
                    isUniversal: ZodOptional<ZodBoolean>;
                    externalAppId: ZodOptional<ZodString>;
                    externalAppUuid: ZodOptional<ZodString>;
                    externalAppKey: ZodOptional<ZodString>;
                    isCustomized: ZodOptional<ZodBoolean>;
                    userId: ZodOptional<ZodString>;
                    tenantId: ZodOptional<ZodOptional<ZodString>>;
                },
                $strip,
            >,
        >;
        connectionId: ZodOptional<ZodString>;
        instanceKey: ZodOptional<ZodString>;
        flowId: ZodOptional<ZodString>;
        universalFlowId: ZodOptional<ZodString>;
        parametersSchema: ZodOptional<
            ZodType<DataSchema, unknown, $ZodTypeInternals<DataSchema, unknown>>,
        >;
        parameters: ZodOptional<ZodAny>;
        enabled: ZodOptional<ZodBoolean>;
        nodes: ZodOptional<
            ZodRecord<
                ZodString,
                ZodObject<
                    {
                        type: ZodOptional<ZodString>;
                        version: ZodOptional<ZodNumber>;
                        name: ZodOptional<ZodString>;
                        description: ZodOptional<ZodString>;
                        config: ZodOptional<ZodAny>;
                        concurrency: ZodOptional<ZodNumber>;
                        onError: ZodOptional<ZodEnum<{ continue: "continue"; stop: "stop" }>>;
                        ui: ZodOptional<ZodAny>;
                        inputSchema: ZodOptional<ZodAny>;
                        outputSchema: ZodOptional<ZodAny>;
                        outputExample: ZodOptional<ZodAny>;
                        links: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        key: ZodOptional<(...)>;
                                        filter: ZodOptional<(...)>;
                                        name: ZodOptional<(...)>;
                                    },
                                    $strip,
                                >,
                            >,
                        >;
                        isCustomized: ZodOptional<ZodBoolean>;
                        state: ZodOptional<ZodEnum<typeof FlowNodeState>>;
                        errors: ZodOptional<
                            ZodArray<
                                ZodType<
                                    ErrorDataSchema,
                                    unknown,
                                    $ZodTypeInternals<ErrorDataSchema, unknown>,
                                >,
                            >,
                        >;
                        userConfig: ZodOptional<ZodAny>;
                        testInput: ZodOptional<ZodAny>;
                        dependencies: ZodOptional<ZodArray<ZodAny>>;
                    },
                    $strip,
                >,
            >,
        >;
        autoCreateInstances: ZodOptional<ZodBoolean>;
        flowRevision: ZodOptional<ZodString>;
        universalFlowRevision: ZodOptional<ZodString>;
        createdAt: ZodOptional<ZodString>;
        updatedAt: ZodOptional<ZodString>;
        state: ZodOptional<ZodEnum<typeof WorkspaceElementState>>;
        customized: ZodOptional<
            ZodObject<
                { name: ZodOptional<ZodBoolean>; nodes: ZodOptional<ZodBoolean> },
                $strip,
            >,
        >;
        dependencies: ZodOptional<ZodArray<ZodAny>>;
        id: ZodString;
        uuid: ZodOptional<ZodString>;
        key: ZodOptional<ZodString>;
        description: ZodOptional<ZodString>;
        meta: ZodOptional<ZodRecord<ZodString, ZodAny>>;
        name: ZodString;
        errors: ZodOptional<
            ZodArray<
                ZodType<
                    ErrorDataSchema,
                    unknown,
                    $ZodTypeInternals<ErrorDataSchema, unknown>,
                >,
            >,
        >;
        revision: ZodOptional<ZodString>;
        archivedAt: ZodOptional<ZodString>;
        isDeactivated: ZodOptional<ZodBoolean>;
        isReadOnly: ZodOptional<ZodBoolean>;
        integrationId: ZodOptional<ZodString>;
        integrationUuid: ZodOptional<ZodString>;
        integrationKey: ZodOptional<ZodString>;
        parentUuid: ZodOptional<ZodString>;
        parentKey: ZodOptional<ZodString>;
        isUniversal: ZodOptional<ZodBoolean>;
        externalAppId: ZodOptional<ZodString>;
        externalAppUuid: ZodOptional<ZodString>;
        externalAppKey: ZodOptional<ZodString>;
        isCustomized: ZodOptional<ZodBoolean>;
        userId: ZodOptional<ZodString>;
        tenantId: ZodOptional<ZodOptional<ZodString>>;
    },
    $strip,
> = ...

Flow API response with full object references. This is a unified type that works for both templates (integration-level) and instances (connection-level).

Templates: connectionId is undefined, userId is undefined
Instances: connectionId is set, userId is set

Variable FlowApiResponseConst

Settings

Variable FlowApiResponse`Const`