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

    Variable ConnectPayloadConst

    ConnectPayload: ZodObject<
        {
            type: ZodOptional<ZodEnum<{ connector: "connector"; mcp: "mcp" }>>;
            requestId: ZodOptional<ZodString>;
            integrationKey: ZodOptional<ZodString>;
            integrationId: ZodOptional<ZodString>;
            connectorId: ZodOptional<ZodString>;
            connectorKey: ZodOptional<ZodString>;
            connectorVersion: ZodOptional<ZodString>;
            externalAppId: ZodOptional<ZodString>;
            externalAppKey: ZodOptional<ZodString>;
            connectionId: ZodOptional<ZodString>;
            connectionKey: ZodOptional<ZodString>;
            name: ZodOptional<ZodString>;
            input: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
            connectionParameters: ZodOptional<ZodAny>;
            connectorParameters: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
            authOptionKey: ZodOptional<ZodString>;
            allowMultipleConnections: ZodOptional<ZodBoolean>;
            redirectUri: ZodOptional<ZodString>;
            customState: ZodOptional<ZodString>;
            connectionRequestId: ZodOptional<ZodString>;
            intent: ZodOptional<ZodString>;
        },
        $strip,
    > = ...

    Payload for the /connect endpoint. Shared between SDK and backend.

    • Provide integrationKey/integrationId to create a new connection for an integration
    • Provide connectorId (+ optional connectorVersion) to create a standalone connection
    • Provide externalAppId/externalAppKey to create a connection for an external app
    • Provide connectionId to reconnect/update an existing connection