Membrane SDK - v0.29.2
    Preparing search index...

    Variable IntegrationApiResponseConst

    IntegrationApiResponse: ZodObject<
        {
            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,
                >,
            >;
            spec: ZodOptional<ZodAny>;
            authOptions: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            key: ZodString;
                            type: ZodEnum<
                                {
                                    proxy: "proxy";
                                    "integration-app-token": "integration-app-token";
                                    "membrane-token": "membrane-token";
                                    oauth2: "oauth2";
                                    oauth1: "oauth1";
                                    "client-credentials": "client-credentials";
                                },
                            >;
                            title: ZodOptional<ZodString>;
                            description: ZodOptional<ZodString>;
                            inputSchema: ZodOptional<
                                ZodType<
                                    DataSchema,
                                    unknown,
                                    $ZodTypeInternals<DataSchema, unknown>,
                                >,
                            >;
                            ui: ZodOptional<
                                ZodObject<
                                    { schema: ZodOptional<ZodAny>; helpUri: ZodOptional<ZodString> },
                                    $strip,
                                >,
                            >;
                        },
                        $strip,
                    >,
                >,
            >;
            id: ZodOptional<ZodString>;
            logoUri: ZodOptional<ZodString>;
            appUri: ZodOptional<ZodString>;
            isConnected: ZodOptional<ZodBoolean>;
            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<ZodString, ZodAny>>;
                        },
                        $strip,
                    >,
                >,
            >;
            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,
    > = ...

    Integration API response.

    Workspace-defined integrations carry a real id; auto-generated integrations do not — they're derived from a source workspace element and may lack id, key, uuid, logoUri, or appUri:

    • From a connector (see autoGenerateIntegrationsFromConnectors workspace setting and the connectors query parameter): connectorId is set.
    • From an external app (see autoGenerateIntegrationsFromExternalApps workspace setting and the externalApps query parameter): externalAppId is set.
    • From a web search (see autoGenerateIntegrationsFromWebSearch workspace setting and the websearch query parameter): only name, logoUri, and appUri are populated — the item has no underlying workspace element.

    appUri (the app's website) is populated whenever available — directly from the source for external-app and web-search items, and via externalAppId → app lookup for workspace-defined items.

    Settings

    Member Visibility