title: Secrets Module description: Workspace-scoped secrets storage for Loopstack workflows — SecretEntity, SecretService, SecretController REST API, GetSecretKeysTool (get_secret_keys), RequestSecretsTool (request_secrets), RequestSecretsTask (request_secrets_task), SecretsRequestWorkflow, SecretRequestDocument. CRUD service, upsert, request secrets from users at runtime.

@loopstack/secrets-module

Secrets management module for the Loopstack automation framework.

Provides workspace-scoped storage for API keys, tokens, and other credentials. Workflows can request secrets from users at runtime, store them securely, and check which secrets are available -- all without exposing values to the LLM.

When to Use

• Your workflow needs credentials at runtime -- an API key, OAuth token, or webhook secret that isn't known until the user provides it.
• You want to check whether secrets exist before branching -- use GetSecretKeysTool to inspect available keys without reading values.
• You need a secure input form in the Studio -- RequestSecretsTool and RequestSecretsTask render a form where users enter secrets that are stored server-side, never sent to the LLM.
• You need CRUD access to secrets from backend code -- inject SecretService directly for programmatic reads, writes, and upserts.

Installation

npm install @loopstack/secrets-module

Register the module in your app module. SecretsModule registers SecretEntity with TypeORM via forFeature internally, so your root TypeOrmModule.forRoot() must include SecretEntity (or load entities via glob).

import { Module } from '@nestjs/common';
import { SecretsModule } from '@loopstack/secrets-module';

@Module({
  imports: [SecretsModule],
})
export class AppModule {}

Use SecretsModule.forFeature() to register with the feature registry (enables opt-in feature toggling):

@Module({
  imports: [SecretsModule.forFeature()],
})
export class AppModule {}

Quick Start

Inject RequestSecretsTool into a workflow to ask the user for secrets, then use GetSecretKeysTool to verify they were stored:

import { BaseWorkflow, MarkdownDocument, Transition, Workflow } from '@loopstack/common';
import { GetSecretKeysTool, RequestSecretsTool, SecretRequestDocument } from '@loopstack/secrets-module';

interface SecretsState {
  secretKeys?: Array<{ key: string; hasValue: boolean }>;
}

@Workflow({
  title: 'Secrets Update Example',
  description: 'Requests secrets from the user and verifies they were stored.',
})
export class SecretsExampleWorkflow extends BaseWorkflow<Record<string, unknown>, SecretsState> {
  constructor(
    private readonly requestSecrets: RequestSecretsTool,
    private readonly getSecretKeys: GetSecretKeysTool,
  ) {
    super();
  }

  @Transition({ to: 'requesting_secrets' })
  async requestSecretsFromUser(state: SecretsState): Promise<SecretsState> {
    await this.requestSecrets.call({
      variables: [{ key: 'EXAMPLE_API_KEY' }, { key: 'EXAMPLE_SECRET' }],
    });

    await this.documentStore.save(SecretRequestDocument, {
      variables: [{ key: 'EXAMPLE_API_KEY' }, { key: 'EXAMPLE_SECRET' }],
    });
    return state;
  }

  @Transition({ from: 'requesting_secrets', to: 'verifying', wait: true })
  async secretsSubmitted(state: SecretsState): Promise<SecretsState> {
    const result = await this.getSecretKeys.call();
    return { ...state, secretKeys: result.data };
  }

  @Transition({ from: 'verifying', to: 'end' })
  async showResult(state: SecretsState): Promise<unknown> {
    await this.documentStore.save(MarkdownDocument, {
      markdown: this.render(__dirname + '/templates/secretsVerified.md', {
        secretKeys: state.secretKeys,
      }),
    });
    return {};
  }
}

How It Works

Requesting secrets from a user

RequestSecretsTool tells the framework which secrets are needed and renders a SecretRequestDocument form in the Studio. The workflow pauses on a wait: true transition until the user submits the form. Values are stored on SecretEntity and never returned to the LLM.

start ──> requesting_secrets ──(wait)──> verifying ──> end
           show form + call        user submits       check keys
           RequestSecretsTool      secrets             & continue

Using RequestSecretsTask in agent workflows

RequestSecretsTask is the agent-friendly variant. It launches SecretsRequestWorkflow as a sub-workflow with a callback (rendered inline in the parent's view via the default show: 'inline'), and resolves when the user completes the form. Use this when an LLM agent decides at runtime which secrets to request.

import { RequestSecretsTask, GetSecretKeysTool, SecretsRequestWorkflow } from '@loopstack/secrets-module';

// In the workflow constructor:
constructor(
  private readonly requestSecrets: RequestSecretsTask,
  private readonly getSecretKeys: GetSecretKeysTool,
  private readonly secretsRequest: SecretsRequestWorkflow,
) {
  super();
}

// Register tools with the LLM:
tools: ['get_secret_keys', 'request_secrets_task']

Reading secrets in server-side code

Inject SecretService for direct CRUD access:

import { Injectable } from '@nestjs/common';
import { SecretService } from '@loopstack/secrets-module';

@Injectable()
export class MyService {
  constructor(private readonly secrets: SecretService) {}

  async getToken(workspaceId: string) {
    const all = await this.secrets.findAllByWorkspace(workspaceId);
    return all.find((s) => s.key === 'GITHUB_TOKEN')?.value;
  }
}

REST API

SecretController exposes CRUD endpoints scoped to a workspace. The GET endpoint returns keys and hasValue flags only -- never the actual secret values.

| Method | Endpoint | Description | | -------- | ------------------------------------------------ | --------------------- | | GET | /api/v1/workspaces/:workspaceId/secrets | List secret keys | | POST | /api/v1/workspaces/:workspaceId/secrets | Create a secret | | PUT | /api/v1/workspaces/:workspaceId/secrets/upsert | Create or update | | PUT | /api/v1/workspaces/:workspaceId/secrets/:id | Update a secret by ID | | DELETE | /api/v1/workspaces/:workspaceId/secrets/:id | Delete a secret by ID |

Tools Reference

get_secret_keys

Returns the list of secret keys available in the current workspace. Does not return secret values.

| Arg | Type | Required | Description | | ---- | ---- | -------- | --------------------- | | none | -- | -- | No arguments required |

Returns: Array<{ key: string; hasValue: boolean }>

request_secrets

Requests secret values from the user. Shows a secure input form in the Studio. Values are stored securely and never exposed to the workflow or LLM. Returns the key names after the user provides the values. Must be the only tool call in the response.

| Arg | Type | Required | Description | | ----------- | ------------------------ | -------- | -------------------------------------------- | | variables | Array<{ key: string }> | Yes | List of secret keys to request from the user |

Returns: { variables: Array<{ key: string }> }

request_secrets_task

Agent-friendly task variant of request_secrets. Launches SecretsRequestWorkflow as a sub-workflow, displays an embedded link document, and completes via callback when the user submits secrets. Must be the only tool call in the response.

| Arg | Type | Required | Description | | ----------- | ------------------------ | -------- | -------------------------------------------- | | variables | Array<{ key: string }> | Yes | List of secret keys to request from the user |

Returns: { workflowId: string } (pending), then "Secrets have been stored securely by the user." (on completion)

Configuration

SecretsModule.forFeature() accepts an optional config object:

SecretsModule.forFeature({ enabled: true });

| Option | Type | Default | Description | | --------- | --------- | ------- | --------------------------------------------- | | enabled | boolean | -- | Opt-in feature toggle for the secrets feature |

Public API

• Module: SecretsModule
• Entity: SecretEntity
• Service: SecretService -- findAllByWorkspace, create, update, upsert, delete
• Controller: SecretController -- REST CRUD under /api/v1/workspaces/:workspaceId/secrets
• Tools: GetSecretKeysTool, RequestSecretsTool, RequestSecretsTask
• Workflow: SecretsRequestWorkflow
• Document: SecretRequestDocument
• Types: GetSecretKeysResult, RequestSecretsResult, RequestSecretsTaskResult

Dependencies

| Package | Role | | ------------------- | ----------------------------------- | | @loopstack/common | Base classes, decorators, types | | @loopstack/core | Framework runtime, WorkspaceService | | @nestjs/common | NestJS dependency injection | | @nestjs/typeorm | TypeORM integration for NestJS | | typeorm | Database ORM (SecretEntity) | | zod | Tool input schema validation |

Related

• Secrets Management docs -- overview of secret tools, how-it-works flow, and template examples
• secrets-example-workflow -- example with both a direct workflow and an agent-based approach using RequestSecretsTask

About

Author: Jakob Klippel

License: MIT