{"id":"BWHQ-AI-001","title":"Dedicated AI data plane and vector lifecycle","summary":"AI sources, chunks, embeddings, retrieval metadata, jobs, and telemetry live in a dedicated AI data plane rather than the main transactional database.","status":"current","authority":"high","domain":"ai","audiences":["ai","developer","architect"],"aliases":["AI database","vector database","embedding pipeline"],"tags":["ai","vectors","rag","embeddings"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-AI-002","BWHQ-AI-003"],"path":"knowledge/ai/bwhq-ai-001-dedicated-ai-data-plane-and-vector-lifecycle.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-001-dedicated-ai-data-plane-and-vector-lifecycle.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-001-dedicated-ai-data-plane-and-vector-lifecycle.html","content_markdown":"# Dedicated AI data plane and vector lifecycle\n\n## Separation\nThe AI/vector database is distinct from the transactional runtime database. This keeps semantic indexing, model migrations, rebuilds, and retrieval telemetry from becoming ad hoc state inside the operational system.\n\n## Current vector pattern\nThe August 2026 architecture includes multi-resolution vector storage and secured retrieval paths. The documented current path uses a smaller embedding for candidate generation and a larger embedding for precision ordering, with an alternate high-resolution route also represented.\n\n## Provenance\nAI chunks carry provenance such as SaaSAppId, AppAccountId, SourceRecordId, SourceModuleId, LocationId, security scope, model/version, chunking version, and hashes/checksums.\n\n## Lifecycle\nIngest source → chunk with versioned rules → embed → persist provenance → retrieve inside authorization scope → rerank/precision pass → log result/latency/model path → rebuild when model or source changes."}
{"id":"BWHQ-AI-002","title":"Permission-aware RAG","summary":"BuildWithHQ resolves the caller’s allowed data envelope before semantic retrieval returns context to the model; prompt text is not treated as the security boundary.","status":"current","authority":"highest","domain":"ai","audiences":["ai","security","developer"],"aliases":["secured RAG","permission-aware retrieval","authorization envelope"],"tags":["rag","security","retrieval","permissions"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_Database_Architecture_Guide_v3.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-001","BWHQ-SEC-002"],"path":"knowledge/ai/bwhq-ai-002-permission-aware-rag.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-002-permission-aware-rag.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-002-permission-aware-rag.html","content_markdown":"# Permission-aware RAG\n\n## Core rule\nDo not retrieve broadly and attempt to remove forbidden content after retrieval. Determine what the caller is allowed to use as AI context first, then search within that boundary.\n\n## Scope carried into retrieval\nThe retrieval layer can include application, AppAccount/tenant, record, module, location, and security-scope information. Allowed records/modules/locations can be resolved before context is assembled.\n\n## AI-specific permission\nHuman read permission does not have to imply permission for AI processing. Enterprises can permit a person to view a record while excluding that record from AI context.\n\n## Citation/provenance\nSourceRecordId should remain connected to retrieved chunks so answers can point back to the permitted source business object."}
{"id":"BWHQ-AI-003","title":"AI orchestration and model routing","summary":"AI jobs and live inference can be routed through an orchestration plane that tracks endpoint capabilities, health, workers, and workload placement independent of a single model provider.","status":"current","authority":"high","domain":"ai","audiences":["ai","ops","developer"],"aliases":["AI orchestration","endpoint routing","cloud burst"],"tags":["ai","orchestration","workers","routing"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_Stored_Procedure_Reference_2026-08.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-AI-001","BWHQ-AI-004"],"path":"knowledge/ai/bwhq-ai-003-ai-orchestration-and-model-routing.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-003-ai-orchestration-and-model-routing.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-003-ai-orchestration-and-model-routing.html","content_markdown":"# AI orchestration and model routing\n\n## Responsibilities\nThe AI/runtime orchestration plane tracks jobs, endpoint capabilities, worker heartbeats, routing, build-spec sessions, app seeding, cloud-burst paths, and tenant-container health.\n\n## Execution patterns\n- Live embedding/reranking can resolve synchronously to a healthy endpoint.\n- Background work can be queued and leased by workers.\n- Different capabilities can route to different hardware/model classes.\n- Managed, local, or burst capacity can sit behind the same application contract.\n\n## Design goal\nApplication logic should not be coupled to one GPU vendor, public API, or inference host. Provider/model identity remains observable for rebuilds, diagnostics, evaluation, and audit."}
{"id":"BWHQ-AI-004","title":"AI harness packs","summary":"AI behavior can be packaged, versioned, evaluated, gated, and distributed like software rather than treated as an untracked prompt string.","status":"current","authority":"medium-high","domain":"ai","audiences":["ai","marketplace","builder"],"aliases":["harness packs","AI behavior packs","prompt release"],"tags":["ai","harness","evaluation","marketplace"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-MKT-001"],"path":"knowledge/ai/bwhq-ai-004-ai-harness-packs.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-004-ai-harness-packs.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/ai/bwhq-ai-004-ai-harness-packs.html","content_markdown":"# AI harness packs\n\n## Model\nA harness pack can contain routing configuration, instructions, vocabulary, rubrics, behavior settings, and evaluation cases.\n\n## Release discipline\nBehavior is snapshotted to a version, evaluated against a test set, and publication can be blocked below a pass threshold. Published versions are exact artifacts rather than mutable prompt blobs.\n\n## Value\nA builder can encode industry behavior once, validate it, and reuse or sell it across SaaS products while retaining a repeatable QA gate."}
{"id":"BWHQ-ARCH-001","title":"Platform planes and database boundaries","summary":"BuildWithHQ separates central control/catalog/orchestration concerns from each SaaS application’s runtime, AI, logging, and custom-code execution boundaries.","status":"current","authority":"high","domain":"architecture","audiences":["developer","architect","ai"],"aliases":["system planes","database planes","control plane","data planes"],"tags":["architecture","database","control-plane","runtime"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_Stored_Procedure_Reference_2026-08.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-BUILDER-001","BWHQ-DATA-001","BWHQ-AI-001"],"path":"knowledge/architecture/bwhq-arch-001-platform-planes-and-database-boundaries.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-001-platform-planes-and-database-boundaries.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-001-platform-planes-and-database-boundaries.html","content_markdown":"# Platform planes and database boundaries\n\n## System-level planes\nThe current architecture is broader than a single two-database design. Central BuildWithHQ responsibilities include control, template/catalog, AI/runtime orchestration, and marketplace/distribution concerns. Per-SaaS application responsibilities are isolated into dedicated runtime/data, AI/vector, logging/compliance, and custom-service execution boundaries.\n\n## Per-SaaS application shape\nA SaaS app is designed to have:\n- a transactional/runtime database for application records and business operations;\n- a separate AI/vector database for sources, chunks, embeddings, retrieval state, and telemetry;\n- a separate compliance/log database for append-oriented history and evidence;\n- an isolated code container/service boundary for custom logic.\n\n## Central control-plane boundary\nBuilder accounts, builder users, platform subscriptions, BuildWithHQ billing, SaaS app registration, routing, resource allocation, domains, API clients, backups, integrations, security metadata, and platform audit belong to the central control plane.\n\n## Rule\nDo not place a generated SaaS product’s end-customer business data or end-customer subscription billing into the BuildWithHQ builder-account control plane."}
{"id":"BWHQ-ARCH-002","title":"Managed and self-hosted deployment","summary":"BuildWithHQ supports a managed runtime and a self-hosted BuildWithHQ Appliance while retaining a centrally governed software catalog and release supply chain.","status":"current","authority":"high","domain":"architecture","audiences":["architect","sales","developer"],"aliases":["BuildWithHQ Appliance","self-hosting","managed runtime"],"tags":["deployment","appliance","self-hosted","managed"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-MKT-001","BWHQ-ARCH-004"],"path":"knowledge/architecture/bwhq-arch-002-managed-and-self-hosted-deployment.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-002-managed-and-self-hosted-deployment.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-002-managed-and-self-hosted-deployment.html","content_markdown":"# Managed and self-hosted deployment\n\n## Managed model\nBuildWithHQ can operate the runtime infrastructure for SaaS applications.\n\n## Self-hosted BuildWithHQ Appliance\nThe BuildWithHQ Appliance means the BuildWithHQ software/runtime stack deployed on infrastructure controlled by an enterprise, MSP, hosting provider, or customer. It is not merely a dedicated AI box.\n\nThe self-hosted operator can run local web/runtime services, SQL Server databases, container infrastructure, optional AI/GPU endpoints, storage, networking, and backups. BuildWithHQ can continue to operate the central Template Library, marketplace metadata, entitlements, release fingerprints, validation state, and install contracts.\n\n## Architectural benefit\nExecution and operational data can remain under customer control while published artifacts still come from a common software supply chain. This preserves portability without fragmenting the product ecosystem."}
{"id":"BWHQ-ARCH-003","title":"Server-driven JSON presentation","summary":"BuildWithHQ represents pages and much application behavior as versioned JSON/schema interpreted by a shared runtime, enabling many application variations from a common codebase.","status":"current","authority":"high","domain":"architecture","audiences":["developer","builder","ai"],"aliases":["schema-driven UI","JSON renderer","decoupled presentation layer","single codebase infinite variations"],"tags":["json","presentation","renderer","metadata-driven"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-001","BWHQ-EXT-001"],"path":"knowledge/architecture/bwhq-arch-003-server-driven-json-presentation.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-003-server-driven-json-presentation.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-003-server-driven-json-presentation.html","content_markdown":"# Server-driven JSON presentation\n\n## Principle\nPages, menus, components, data bindings, role visibility, workflows, actions, and configuration can be represented as JSON rather than compiled into a unique frontend codebase for every tenant.\n\n## Runtime\nA shared renderer interprets the saved structure. BuildWithHQ can patch and secure the common rendering/execution engine while applications diverge through data/configuration.\n\n## Builder workflow\nA builder can work visually, inspect or edit raw JSON, and use structured developer tooling. If JSON/schema is no longer the right abstraction, the next layer is an API/custom-service boundary rather than a forced platform ceiling.\n\n## Tenant customization\nTenant-specific page/layout overrides can exist without forking the whole platform. Presentation metadata can narrow visibility but must not be treated as an authorization boundary."}
{"id":"BWHQ-ARCH-004","title":"Template snapshot isolation and explicit upgrades","summary":"Published template versions are installed as private application state pinned to a known version; upstream changes do not silently mutate running customer applications.","status":"current","authority":"high","domain":"architecture","audiences":["developer","marketplace","support"],"aliases":["snapshot isolation","template fork","private install","exact-version install"],"tags":["templates","versions","snapshot","upgrades"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-MKT-001"],"path":"knowledge/architecture/bwhq-arch-004-template-snapshot-isolation-and-explicit-upgrades.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-004-template-snapshot-isolation-and-explicit-upgrades.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/architecture/bwhq-arch-004-template-snapshot-isolation-and-explicit-upgrades.html","content_markdown":"# Template snapshot isolation and explicit upgrades\n\n## Installation behavior\nA published artifact is versioned and fingerprinted. Installation resolves an exact version and materializes it into the destination application’s private scope.\n\n## Consequences\n- Master-template edits do not silently break downstream applications.\n- White-label/customer customizations remain private.\n- Runtime reads can resolve local application state rather than continuously joining a master template with layered overrides.\n- Support can identify the baseline version/fingerprint an installation came from.\n\n## Upgrades\nUpstream upgrades are explicit events. Stable component identities and baseline history can support a three-way comparison between the old baseline, the customer’s private changes, and the new upstream version. Conflicts should be surfaced rather than overwritten silently."}
{"id":"BWHQ-BUILD-001","title":"Build This: ActiveWorkplace","summary":"Pin a customer, claim, opportunity, invoice, project, case, contract, or any other record. ActiveWorkplace brings its permitted recursive relationships into one live work surface where people, GoClaws, workflows, and automation can work the full context together.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["ActiveWorkplace","Turn any record into a living workplace."],"tags":["build-this","example-product","activeworkplace"],"source_refs":["https://buildwithhq.com/buildthis/activeworkplace.html"],"last_reviewed":"2026-08-27","related":["BWHQ-PROD-001","BWHQ-DATA-001","BWHQ-GOCLAW-001"],"path":"knowledge/build-it-ideas/activeworkplace.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/activeworkplace.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/activeworkplace.html","content_markdown":"# Build This: ActiveWorkplace\n\n## Product pattern\n**Turn any record into a living workplace.**\n\nPin a customer, claim, opportunity, invoice, project, case, contract, or any other record. ActiveWorkplace brings its permitted recursive relationships into one live work surface where people, GoClaws, workflows, and automation can work the full context together.\n\nActiveWorkplace is not a chat room attached to a record and it does not copy business data into a new silo. The pinned record stays real, every related node stays real, and the workplace becomes a permission-filtered projection over the live BuildWithHQ record graph.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-002","title":"Build This: AssetOps","summary":"Build field-service, facilities, fleet, property, equipment, inspection, or maintenance software that connects customers and locations to assets, inspections, work orders, technicians, parts, photos, documents, invoices, and complete service history.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["AssetOps","Connect every asset to the work required to keep it running."],"tags":["build-this","example-product","assetops"],"source_refs":["https://buildwithhq.com/buildthis/assetops.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/assetops.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/assetops.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/assetops.html","content_markdown":"# Build This: AssetOps\n\n## Product pattern\n**Connect every asset to the work required to keep it running.**\n\nBuild field-service, facilities, fleet, property, equipment, inspection, or maintenance software that connects customers and locations to assets, inspections, work orders, technicians, parts, photos, documents, invoices, and complete service history.\n\nTemperature was flagged in three of the last four inspections. Similar service history suggests scheduling diagnostics before the next peak-load period.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-003","title":"Build This: CaseFlow","summary":"Build software for claims, applications, investigations, compliance reviews, onboarding, service requests, permits, underwriting, HR matters, or any process where a record moves through stages while accumulating people, documents, conversations, tasks, decisions, and approvals.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["CaseFlow","Turn complex cases into controlled, explainable workflows."],"tags":["build-this","example-product","caseflow"],"source_refs":["https://buildwithhq.com/buildthis/caseflow.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/caseflow.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/caseflow.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/caseflow.html","content_markdown":"# Build This: CaseFlow\n\n## Product pattern\n**Turn complex cases into controlled, explainable workflows.**\n\nBuild software for claims, applications, investigations, compliance reviews, onboarding, service requests, permits, underwriting, HR matters, or any process where a record moves through stages while accumulating people, documents, conversations, tasks, decisions, and approvals.\n\nThe questionnaire is mostly complete. A SOC 2 exhibit is still missing and the data-retention response requires Legal review before the case can advance.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-004","title":"Build This: CompanyIQ","summary":"Ingest company documents, chunk and embed them for permission-aware search, then combine that knowledge with customers, past sales, pending deals, activity, support history, and other records. Scheduled AI analysis can surface new opportunities, risks, and next actions—especially inside the customer relationships you already have.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["CompanyIQ","Turn everything your company knows into opportunities your team can act on."],"tags":["build-this","example-product","companyiq"],"source_refs":["https://buildwithhq.com/buildthis/companyiq.html"],"last_reviewed":"2026-08-27","related":["BWHQ-PROD-002","BWHQ-AI-002"],"path":"knowledge/build-it-ideas/companyiq.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/companyiq.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/companyiq.html","content_markdown":"# Build This: CompanyIQ\n\n## Product pattern\n**Turn everything your company knows into opportunities your team can act on.**\n\nIngest company documents, chunk and embed them for permission-aware search, then combine that knowledge with customers, past sales, pending deals, activity, support history, and other records. Scheduled AI analysis can surface new opportunities, risks, and next actions—especially inside the customer relationships you already have.\n\nRecent support themes, project documents, past purchase history, and an open implementation milestone all point to a likely need for the premium onboarding package.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-005","title":"Build This: CrewOS","summary":"A coordinated workforce of specialized AI operators — each with its own role, context, tools, authority, and approval rules.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["CrewOS","Run your business with an AI team , not a chatbot."],"tags":["build-this","example-product","crewos"],"source_refs":["https://buildwithhq.com/buildthis/crewos.html"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-001","BWHQ-GOCLAW-005"],"path":"knowledge/build-it-ideas/crewos.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/crewos.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/crewos.html","content_markdown":"# Build This: CrewOS\n\n## Product pattern\n**Run your business with an AI team , not a chatbot.**\n\nA coordinated workforce of specialized AI operators — each with its own role, context, tools, authority, and approval rules.\n\nBuild an AI workforce that coordinates specialized operators, governed actions, approvals, shared context, and a complete execution trail. Start with the product pattern, then shape the data model, screens, automation, permissions, integrations, and brand around your market.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-006","title":"Build This: CustomerPortal","summary":"Build a customer-facing portal that sits beside your internal application—sharing selected conversations, files, requests, approvals, milestones, and updates while your team keeps private notes, workflows, and operational detail on the inside.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["CustomerPortal","Give customers a shared workspace without exposing your internal one."],"tags":["build-this","example-product","customerportal"],"source_refs":["https://buildwithhq.com/buildthis/customerportal.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/customerportal.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/customerportal.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/customerportal.html","content_markdown":"# Build This: CustomerPortal\n\n## Product pattern\n**Give customers a shared workspace without exposing your internal one.**\n\nBuild a customer-facing portal that sits beside your internal application—sharing selected conversations, files, requests, approvals, milestones, and updates while your team keeps private notes, workflows, and operational detail on the inside.\n\nCustomer sees the milestone summary, shared files and approval button. Your team also sees private notes, owner, risk score and next workflow step.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-007","title":"Build This: FieldService","summary":"Build field-service SaaS for HVAC, plumbing, electrical, appliance repair, facilities, inspections, maintenance, or any service business that needs customers, service areas, teams, schedules, jobs, approvals, files, conversations, AI assistance, estimates, and follow-up in one product.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["FieldService","Run every service call from first request to final follow-up."],"tags":["build-this","example-product","fieldservice"],"source_refs":["https://buildwithhq.com/buildthis/fieldservice.html"],"last_reviewed":"2026-08-27","related":["BWHQ-MOD-001","BWHQ-MOD-002","BWHQ-MOD-003","BWHQ-MOD-004"],"path":"knowledge/build-it-ideas/fieldservice.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/fieldservice.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/fieldservice.html","content_markdown":"# Build This: FieldService\n\n## Product pattern\n**Run every service call from first request to final follow-up.**\n\nBuild field-service SaaS for HVAC, plumbing, electrical, appliance repair, facilities, inspections, maintenance, or any service business that needs customers, service areas, teams, schedules, jobs, approvals, files, conversations, AI assistance, estimates, and follow-up in one product.\n\nThe job history and authorized evidence are assembled for review, with the estimator available through a controlled service endpoint.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-008","title":"Build This: Headless SaaS DB","summary":"Build your customer experience in React, Vue, Next.js, mobile, a native desktop app, or an existing codebase. Use BuildWithHQ as the managed SaaS backend and expose the platform’s records, relationships, permissions, workflows, AI, files, webhooks, audit trail, and custom services through APIs.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["Headless SaaS DB","Bring any frontend. Keep the backend."],"tags":["build-this","example-product","headless-saas-db"],"source_refs":["https://buildwithhq.com/buildthis/headless-saas-db.html"],"last_reviewed":"2026-08-27","related":["BWHQ-EXT-002","BWHQ-SEC-001"],"path":"knowledge/build-it-ideas/headless-saas-db.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/headless-saas-db.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/headless-saas-db.html","content_markdown":"# Build This: Headless SaaS DB\n\n## Product pattern\n**Bring any frontend. Keep the backend.**\n\nBuild your customer experience in React, Vue, Next.js, mobile, a native desktop app, or an existing codebase. Use BuildWithHQ as the managed SaaS backend and expose the platform’s records, relationships, permissions, workflows, AI, files, webhooks, audit trail, and custom services through APIs.\n\nA customer action hits the API layer, permissions are evaluated server-side, the requested record or workflow is processed, and audit evidence is captured before the response returns to your UI.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-009","title":"Build This: LaunchPilot","summary":"A marketing operations cockpit that assembles audiences, generates assets, routes approvals, activates channels, measures experiments, and optimizes inside defined authority.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["LaunchPilot","From campaign brief to governed launch."],"tags":["build-this","example-product","launchpilot"],"source_refs":["https://buildwithhq.com/buildthis/launchpilot.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/launchpilot.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/launchpilot.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/launchpilot.html","content_markdown":"# Build This: LaunchPilot\n\n## Product pattern\n**From campaign brief to governed launch.**\n\nA marketing operations cockpit that assembles audiences, generates assets, routes approvals, activates channels, measures experiments, and optimizes inside defined authority.\n\nBuild an AI marketing operations product that assembles audiences, creates assets, routes approvals, activates channels, measures experiments, and optimizes within defined authority. Start with the product pattern, then shape the data model, screens, automation, permissions, integrations, and brand around your market.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-010","title":"Build This: Northstar","summary":"An executive decision layer that compresses company-wide operating changes into a small number of material signals, forecasts, risks, opportunities, and evidence-backed decisions.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["Northstar","Know what changed. Know what deserves attention."],"tags":["build-this","example-product","northstar"],"source_refs":["https://buildwithhq.com/buildthis/northstar.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/northstar.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/northstar.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/northstar.html","content_markdown":"# Build This: Northstar\n\n## Product pattern\n**Know what changed. Know what deserves attention.**\n\nAn executive decision layer that compresses company-wide operating changes into a small number of material signals, forecasts, risks, opportunities, and evidence-backed decisions.\n\nBuild an executive intelligence product that compresses company-wide operating changes into material signals, forecasts, risks, opportunities, and evidence-backed decisions. Start with the product pattern, then shape the data model, screens, automation, permissions, integrations, and brand around your market.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-011","title":"Build This: OpsAtlas","summary":"Turn SOPs, policies, manuals, training, internal documentation, system guides, and hard-won tribal knowledge into a permission-aware operating memory. Employees can ask how work gets done, AI agents can retrieve trusted instructions before acting, and every answer can point back to its evidence.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["OpsAtlas","Make your company’s operating knowledge available on demand."],"tags":["build-this","example-product","opsatlas"],"source_refs":["https://buildwithhq.com/buildthis/opsatlas.html"],"last_reviewed":"2026-08-27","related":["BWHQ-AI-002","BWHQ-DATA-001"],"path":"knowledge/build-it-ideas/opsatlas.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/opsatlas.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/opsatlas.html","content_markdown":"# Build This: OpsAtlas\n\n## Product pattern\n**Make your company’s operating knowledge available on demand.**\n\nTurn SOPs, policies, manuals, training, internal documentation, system guides, and hard-won tribal knowledge into a permission-aware operating memory. Employees can ask how work gets done, AI agents can retrieve trusted instructions before acting, and every answer can point back to its evidence.\n\nConfirm the shipment status, open the customer record, select the fulfilled order, choose Partial Refund, enter the approved amount, and route refunds above the manager threshold for approval. Based on Refund Policy v4.2 and Support SOP 7.3.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-012","title":"Build This: RelateEverything","summary":"Build a CRM where contacts, companies, files, documents, calendar events, tasks, projects, conversations, and custom records can relate to one another—so every item reveals the full context around it.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["RelateEverything","Start anywhere. See everything connected."],"tags":["build-this","example-product","relateeverything"],"source_refs":["https://buildwithhq.com/buildthis/relateeverything.html"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001"],"path":"knowledge/build-it-ideas/relateeverything.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/relateeverything.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/relateeverything.html","content_markdown":"# Build This: RelateEverything\n\n## Product pattern\n**Start anywhere. See everything connected.**\n\nBuild a CRM where contacts, companies, files, documents, calendar events, tasks, projects, conversations, and custom records can relate to one another—so every item reveals the full context around it.\n\n3 contacts · MSA.pdf · kickoff meeting · 6 tasks · support thread · renewal date · implementation project\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-013","title":"Build This: Reservations","summary":"Build an authenticated reservations product for service businesses that need configurable offerings, booking duration and buffers, contacts, calendar placement, staff or resource assignment, capacity controls, payment state, and pre/post-service communications in one secured workflow.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["Reservations","Connect bookable services, capacity, payments, calendars, and follow-up."],"tags":["build-this","example-product","reservations"],"source_refs":["https://buildwithhq.com/buildthis/reservations.html"],"last_reviewed":"2026-08-27","related":["BWHQ-MOD-001","BWHQ-MOD-002"],"path":"knowledge/build-it-ideas/reservations.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/reservations.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/reservations.html","content_markdown":"# Build This: Reservations\n\n## Product pattern\n**Connect bookable services, capacity, payments, calendars, and follow-up.**\n\nBuild an authenticated reservations product for service businesses that need configurable offerings, booking duration and buffers, contacts, calendar placement, staff or resource assignment, capacity controls, payment state, and pre/post-service communications in one secured workflow.\n\nThe contact was created or reused, an authorized tenant user was assigned, capacity was protected, and follow-up work was scheduled around the service.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-014","title":"Build This: Resolve","summary":"An AI support operation that identifies the customer, understands the request, checks records and policy, executes permitted resolutions, and escalates exceptions.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["Resolve","Let AI resolve the issue — safely."],"tags":["build-this","example-product","resolve"],"source_refs":["https://buildwithhq.com/buildthis/resolve.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/resolve.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/resolve.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/resolve.html","content_markdown":"# Build This: Resolve\n\n## Product pattern\n**Let AI resolve the issue — safely.**\n\nAn AI support operation that identifies the customer, understands the request, checks records and policy, executes permitted resolutions, and escalates exceptions.\n\nBuild an AI support product that understands customer requests, checks records and policy, executes permitted resolutions, and escalates exceptions with full context. Start with the product pattern, then shape the data model, screens, automation, permissions, integrations, and brand around your market.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-015","title":"Build This: SignalIQ","summary":"A revenue intelligence system that turns CRM history, usage, intent, engagement, and account movement into a ranked action queue.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["SignalIQ","Know which deal matters next."],"tags":["build-this","example-product","signaliq"],"source_refs":["https://buildwithhq.com/buildthis/signaliq.html"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/build-it-ideas/signaliq.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/signaliq.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/signaliq.html","content_markdown":"# Build This: SignalIQ\n\n## Product pattern\n**Know which deal matters next.**\n\nA revenue intelligence system that turns CRM history, usage, intent, engagement, and account movement into a ranked action queue.\n\nBuild a revenue intelligence product that turns CRM history, intent, usage, engagement, and account movement into prioritized actions for sales teams. Start with the product pattern, then shape the data model, screens, automation, permissions, integrations, and brand around your market.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILD-016","title":"Build This: TeamBox","summary":"Bring email, web forms, SMS, and other inbound communications into one team inbox where AI can classify, connect, prioritize, suggest actions, and queue work for people to approve or complete.","status":"specified","authority":"medium","domain":"build-it-idea","audiences":["builder","marketing","product","ai"],"aliases":["TeamBox","Turn every incoming message into organized work."],"tags":["build-this","example-product","teambox"],"source_refs":["https://buildwithhq.com/buildthis/teambox.html"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-002","BWHQ-GOCLAW-005"],"path":"knowledge/build-it-ideas/teambox.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/teambox.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/build-it-ideas/teambox.html","content_markdown":"# Build This: TeamBox\n\n## Product pattern\n**Turn every incoming message into organized work.**\n\nBring email, web forms, SMS, and other inbound communications into one team inbox where AI can classify, connect, prioritize, suggest actions, and queue work for people to approve or complete.\n\nAI matched the sender to Acme Corp, found the onboarding project and calendar event, and prepared the next actions.\n\n## Catalog interpretation\nThis is a **Build This / Build It example product pattern** showing a SaaS category a builder can create, brand, extend, and sell with BuildWithHQ. It is not a statement that this product is automatically included with every BuildWithHQ account.\n\n## Source page\nThe current public Build This page is recorded in `source_refs`. Keep future implementation-specific material in this same directory rather than creating a separate top-level product tree unless the example graduates into a first-class platform subsystem."}
{"id":"BWHQ-BUILDER-001","title":"Builder account control plane","summary":"The builder portal manages the BuildWithHQ customer account, team, platform billing, portfolio, resource allocation, domains, API clients, backups, integrations, sessions, and audit—not the SaaS end-customer data plane.","status":"current","authority":"highest","domain":"builder","audiences":["builder","developer","support"],"aliases":["builder portal","customer control plane","account admin"],"tags":["builder","control-plane","billing","portfolio"],"source_refs":["BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx"],"last_reviewed":"2026-08-27","related":["BWHQ-ARCH-001","BWHQ-BUILDER-002"],"path":"knowledge/builder/bwhq-builder-001-builder-account-control-plane.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/builder/bwhq-builder-001-builder-account-control-plane.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/builder/bwhq-builder-001-builder-account-control-plane.html","content_markdown":"# Builder account control plane\n\n## In scope\nBuilder account/profile, team users and roles, communication preferences, authentication/session state, BuildWithHQ subscription and Stripe reconciliation, SaaS portfolio, shared resource pools, domains, API clients, backups/destinations, integrations, and audit history.\n\n## Out of scope\nThe builder-account portal is not the SaaS application’s end-user CRM/product database, end-user subscription ledger, direct SQL admin UI, or the visual page/template builder itself.\n\n## Request boundary\nThe React/browser layer does not talk directly to SQL Server or Stripe. A backend API validates identity, injects CustomerAccountId/BuilderUserId/SaaSAppId context, checks authorization, maps routes to stored procedures/services, and converts failures into safe responses.\n\n## Data mutation rule\nUse controlled stored procedures/service roles rather than direct browser-facing table DML."}
{"id":"BWHQ-BUILDER-002","title":"Wholesale resource pools and per-app allocation","summary":"Builder accounts manage separate shared capacity pools for primary DB, log DB, AI DB, and container storage and allocate those resources across their SaaS portfolio.","status":"current","authority":"high","domain":"builder","audiences":["builder","billing","ops"],"aliases":["resource pooling","storage pool","wholesale capacity"],"tags":["resources","storage","quota","portfolio"],"source_refs":["BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx","BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-BUILDER-001"],"path":"knowledge/builder/bwhq-builder-002-wholesale-resource-pools-and-per-app-allocation.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/builder/bwhq-builder-002-wholesale-resource-pools-and-per-app-allocation.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/builder/bwhq-builder-002-wholesale-resource-pools-and-per-app-allocation.html","content_markdown":"# Wholesale resource pools and per-app allocation\n\n## Resources are separate\nPrimary database, logging database, AI/vector database, and container storage are distinct resource types. Do not collapse them into one ambiguous “storage” number.\n\n## Allocation model\nThe account owns plan capacity plus purchased add-ons. It assigns capacity to individual SaaS apps. Allocation changes must respect shared-pool headroom and concurrency rules so simultaneous requests cannot overdraw the pool.\n\n## Operational thresholds\nThe portal specification calls for visible warning thresholds as utilization approaches capacity.\n\n## Commercial effect\nPortfolio-level resource pooling fits agencies/MSPs better than forcing each small SaaS app into a separate retail infrastructure subscription. Usage growth can drive automated capacity expansion."}
{"id":"BWHQ-BIZ-001","title":"Commercial model and operational leverage","summary":"BuildWithHQ’s model can combine builder subscriptions, portfolio resource expansion, marketplace economics, builder-to-customer monetization, and self-hosted licensing/support.","status":"specified","authority":"medium-high","domain":"business","audiences":["sales","investor","builder"],"aliases":["business model","NDR","resource expansion"],"tags":["business","pricing","marketplace","ndr"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/business/bwhq-biz-001-commercial-model-and-operational-leverage.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/business/bwhq-biz-001-commercial-model-and-operational-leverage.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/business/bwhq-biz-001-commercial-model-and-operational-leverage.html","content_markdown":"# Commercial model and operational leverage\n\n## Revenue layers\nPotential revenue layers include builder-platform subscriptions, resource/capacity expansion, marketplace fees/revenue share, participation in builder-to-customer recurring revenue, and self-hosted Appliance licensing/support.\n\n## Economic unit\nThe architecture is oriented toward a builder/agency operating a portfolio of SaaS products rather than pricing every BuildWithHQ capability as an isolated end-user seat.\n\n## Operational leverage\nResource monitoring, capacity allocation, backup/provisioning jobs, billing reconciliation, and marketplace delivery are designed for automation so customer growth can translate into recurring expansion without proportional support headcount.\n\n## Status note\nExact commercial terms are product decisions and may change; this item describes the architectural business model, not a guaranteed current price list.\n\n## Builder economics calculator\nThe public [Builder Earnings Calculator](https://buildwithhq.com/earnings-calculator.html) provides an interactive planning model for seat price, recurring revenue, a draft 10% base SaaS platform share, price-sensitive system fees, and builder retained revenue. It also models an AI Support add-on starting at $5 per customer company per month, with 25% of AI Support add-on revenue allocated to BuildWithHQ and 75% retained by the builder. AI Support is modeled separately from the 10% base SaaS share. Calculator assumptions are illustrative until final commercial terms are published."}
{"id":"BWHQ-DATA-001","title":"Universal Record model","summary":"Important application objects share a universal RecordId so records, relations, security, search, AI, audit, favorites, and workflows can operate across modules.","status":"current","authority":"high","domain":"data","audiences":["developer","builder","ai"],"aliases":["Everything is a Record","RecordId","universal records"],"tags":["records","recordid","graph","relations"],"source_refs":["BuildWithHQ_Database_Architecture_Guide_v3.pdf","BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-002","BWHQ-PROD-001","BWHQ-SEC-001"],"path":"knowledge/data/bwhq-data-001-universal-record-model.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-001-universal-record-model.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-001-universal-record-model.html","content_markdown":"# Universal Record model\n\n## RecordId\nBuildWithHQ uses a universal record identity so first-class and custom entities can share common platform behavior. Examples can include files, calendar events, messages, contacts, knowledge items, jobs, discussion objects, and other module entities.\n\n## Why it matters\nA common RecordId lets cross-cutting systems anchor to the same object identity: security context, tenant scope, module scope, location scope, lifecycle state, relations, AI provenance, audit history, favorites, and workflows.\n\n## RecordRelations\nRecordRelations connects records to other records. This is the basis of the “anything can relate to anything” model. Relation operations must preserve tenant/security boundaries rather than becoming an alternate path around authorization.\n\n## Design rule\nFeature-specific tables may contain domain fields, but important business entities should participate in the universal record layer when they need common BuildWithHQ behavior."}
{"id":"BWHQ-DATA-002","title":"AppAccount multi-tenancy boundary","summary":"Inside a generated SaaS database, AppAccountId is the primary tenant isolation boundary and must be derived/validated server-side for record and AI operations.","status":"current","authority":"high","domain":"data","audiences":["developer","security","ai"],"aliases":["AppAccount","AppAccountId","tenant boundary"],"tags":["tenancy","appaccount","isolation","security"],"source_refs":["BuildWithHQ_Database_Architecture_Guide_v3.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-ARCH-001","BWHQ-AI-002"],"path":"knowledge/data/bwhq-data-002-appaccount-multi-tenancy-boundary.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-002-appaccount-multi-tenancy-boundary.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-002-appaccount-multi-tenancy-boundary.html","content_markdown":"# AppAccount multi-tenancy boundary\n\n## Model\nA generated SaaS can host multiple internal customer organizations. These organizations are represented as AppAccounts. Their users and application data are scoped by AppAccountId.\n\n## Required behavior\n- Runtime APIs derive the effective AppAccountId from authenticated identity/session context.\n- Browser-posted tenant IDs are not trusted as authority.\n- Record queries include tenant scope.\n- Relation creation validates that both participating records are allowed within the same intended tenant/security boundary.\n- RAG/vector retrieval includes tenant scope before context is returned to an AI model.\n\n## Distinction\nA BuildWithHQ builder/customer account in the central control plane is not the same thing as an AppAccount inside one of that builder’s SaaS applications."}
{"id":"BWHQ-DATA-003","title":"Dynamic fields, views, menus, modules, and user experiences","summary":"BuildWithHQ uses metadata-driven fields, views, menus, modules, workflows, and user types to customize a SaaS without hard-coding every variation.","status":"current","authority":"medium-high","domain":"data","audiences":["builder","developer"],"aliases":["dynamic schema","UserTypes","ModuleViews","NavigationMenus"],"tags":["modules","fields","views","menus","user-types"],"source_refs":["BuildWithHQ_Database_Architecture_Guide_v3.pdf","BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-ARCH-003","BWHQ-DEV-002"],"path":"knowledge/data/bwhq-data-003-dynamic-fields-views-menus-modules-and-user-experiences.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-003-dynamic-fields-views-menus-modules-and-user-experiences.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/data/bwhq-data-003-dynamic-fields-views-menus-modules-and-user-experiences.html","content_markdown":"# Dynamic fields, views, menus, modules, and user experiences\n\n## Customization model\nThe runtime model includes dynamic field definitions/values, module views, navigation menus/items, modules, workflows, and user experience/role metadata.\n\n## UserTypes\nUserTypes describe application experiences such as Admin, Customer, Employee, Contractor, Dispatcher, or Field Tech. They help shape portal/navigation behavior. Authorization must still be enforced in the backend/security layer.\n\n## Views\nModule views can describe table, detail, calendar, kanban, dashboard, form, or custom presentations.\n\n## Goal\nThe application should vary through metadata and saved schema where practical, avoiding source-code forks for normal customer differences."}
{"id":"BWHQ-DEV-001","title":"Isolated Developer VM","summary":"Each developer can work in an isolated no-unrestricted-internet VM with a local PostgreSQL instance; BuildWithHQ-controlled gateways mediate external AI, packages, MCP, integrations, artifacts, and deployment.","status":"specified","authority":"medium-high","domain":"developer","audiences":["developer","security","ai"],"aliases":["Developer VM","no-internet developer environment","local PostgreSQL"],"tags":["developer-vm","postgresql","isolation","gateways"],"source_refs":[],"last_reviewed":"2026-08-27","related":["BWHQ-EXT-003","BWHQ-EXT-001"],"path":"knowledge/developer/bwhq-dev-001-isolated-developer-vm.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/developer/bwhq-dev-001-isolated-developer-vm.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/developer/bwhq-dev-001-isolated-developer-vm.html","content_markdown":"# Isolated Developer VM\n\n## Environment\nThe developer VM is an isolated development machine intended to give developers real coding freedom without placing BuildWithHQ core systems, production data, or unrestricted network access inside the same trust boundary.\n\n## Local data\nEach developer VM should run its own local PostgreSQL instance for developer-controlled application data and testing.\n\n## Boundary-crossing services\nExternal AI, MCP, package acquisition, documentation retrieval, integrations, deployment, Git/artifact movement, and other internet-facing actions should pass through BuildWithHQ-controlled gateways or explicitly approved services.\n\n## Goal\nProvide a normal development experience and custom-code escape hatch while keeping the platform core, credentials, production data, and outbound network policy under controlled boundaries."}
{"id":"BWHQ-DEV-002","title":"Puck page design and TailAdmin-style React customization","summary":"BuildWithHQ combines Puck composition, TailAdmin-derived tokens, shared React primitives, and app-scoped CSS and asset hosting so builders can polish each SaaS page without bypassing secured routes or module lifecycle ownership.","status":"current","authority":"high","domain":"developer","audiences":["developer","builder"],"aliases":["Developer Mode","Puck editor","TailAdmin template customization","React page design","SaaS asset hosting"],"tags":["puck","tailadmin","react","css","assets","visual-builder","templates"],"source_refs":["apps/tenant-runtime/src/main.tsx","apps/tenant-runtime/src/styles.css","apps/tenant-runtime/src/RuntimeAssetManager.tsx","services/tenant-runtime/PublicTenantAssetsController.vb","packages/ui/src/professional.css","packages/ui/src/professional-primitives.tsx","templates/tailadmin-battle-system/README.md","https://support.buildwithhq.com/builder-guide/saas-css-and-design-assets.html","https://support.buildwithhq.com/partners/asset-domain-and-storage-deployment.html","https://support.buildwithhq.com/builder-guide/tailadmin-template-design-and-react-customization.html"],"last_reviewed":"2026-09-14","related":["BWHQ-ARCH-003","BWHQ-ARCH-004","BWHQ-DATA-003","BWHQ-SEC-001"],"path":"knowledge/developer/bwhq-dev-002-role-aware-in-context-developer-mode.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/developer/bwhq-dev-002-role-aware-in-context-developer-mode.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/developer/bwhq-dev-002-role-aware-in-context-developer-mode.html","content_markdown":"# Puck page design and TailAdmin-style React customization\n\n## Current page-design workflow\nIn the Builder design workspace, select the target User Type, menu, or shared page; use Puck for normal page composition or Monaco for reviewed advanced JSON; preview the result; save the draft; validate it; and publish it. Role preview explains presentation differences, but server authorization remains authoritative for all data and actions.\n\n## CSS ownership and import order\nThe tenant runtime loads `@buildwithhq/ui/professional.css` before its local `styles.css`. Shared professional primitives and their states belong in `packages/ui`; application-shell tokens and app-specific overrides belong in the tenant runtime. Keep the cascade explicit so a template can change color, typography, density, radius, and shadow without duplicating module behavior.\n\nFor a single SaaS, App Assets provides a Custom CSS window. It previews UTF-8 CSS and publishes a validated public `theme.css`; the runtime activates the latest public stylesheet for that app. Published CSS may reference relative URLs, fragments, or public assets under that same SaaS app's asset prefix. It cannot contain imports, executable URL schemes, legacy scriptable CSS expressions, embedded HTML, or cross-app remote asset URLs.\n\n## SaaS asset hosting\nApp Assets accepts a builder-selected virtual folder such as `brand/images` and can expose explicitly public files at `https://assets.buildwithhq.com/{saasAppId}/{assetId}`. The appliance operator alone configures the physical `BWHQ_FILE_STORAGE_ROOT`; neither the browser nor page JSON receives a disk path. All filename extensions except `.dll`, `.com`, and `.exe` may be stored, but only validated stylesheets and passive image, video, font, and PDF content render inline. Other types download as inert attachments with browser hardening. DNS, TLS, and proxy routing for the asset host are deployment responsibilities.\n\nA trusted backend can automate the dashboard's complete styling model through the Developer API. `GET/PUT /v1/apps/{saasAppId}/theme` and SDK `getTheme`/`updateTheme` manage the version-fenced app theme, validated `--runtime-*` variables, and bounded base tokens with `themes.read`/`themes.write`. Asset routes and SDK methods manage compiled CSS, logos, fonts, and images with `assets.read`/`assets.write`; uploads default to private, public delivery is explicit, and asset types use the fixed document/font/image/stylesheet/video set. Page drafts and publishing manage per-page structure and tokens. Tailwind is compiled in the developer's own React project and the production CSS is uploaded—the API does not execute npm, plugins, arbitrary JavaScript, or customer build scripts. The API derives the app and database route from its credential and never accepts or returns the physical storage root, storage key, database, or connection string.\n\n## React ownership\nReusable visual primitives belong in `packages/ui/src/professional-primitives.tsx`. Native module list, detail, create, edit, archive, and other lifecycle experiences remain owned by their module React implementation and exact typed API routes. Puck owns page composition and bound blocks; it does not replace secured module lifecycle routes with inert mock controls.\n\n## Adapting TailAdmin\nTreat a licensed TailAdmin source as a visual reference. Map its colors and spacing into BuildWithHQ tokens, translate repeated patterns into shared primitives, use the bounded icon registry, and preserve BuildWithHQ routing, identity, bindings, permissions, error handling, and stored-procedure-backed application services. Do not copy TailAdmin navigation or authentication logic over the runtime shell.\n\n## Page-by-page finish standard\nPolish shared primitives first, then the shell, dashboards, high-use list pages, detail pages, create/edit forms, and secondary states. Every user-managed first-class entity must retain create, view, update, and safe removal behavior. Exercise empty, loading, populated, validation-error, permission-denied, stale-write, and successful-mutation states at desktop and mobile widths.\n\n## Publishing templates\nComplete and route-test the working SaaS application before harvesting it. Template publishing captures an exact reviewed version; installed customer copies remain isolated from later upstream edits until an explicit upgrade.\n\nThe current template-pack member contract does not copy SaaS asset bytes or remap a source app's asset URLs into an installed app. Public URLs are immutable and work for the source SaaS, but an asset-dependent template is not yet a self-contained portable install. Do not represent it as portable until exact-version asset packaging, destination upload, fingerprint verification, and page/CSS URL remapping are implemented and tested.\n\n## Step-by-step guide\nUse [Host SaaS CSS, logos, images, and design assets](https://support.buildwithhq.com/builder-guide/saas-css-and-design-assets.html) for the builder workflow and [Deploy the SaaS asset domain and storage root](https://support.buildwithhq.com/partners/asset-domain-and-storage-deployment.html) for appliance configuration. [Apply a TailAdmin-style design and customize every React page](https://support.buildwithhq.com/builder-guide/tailadmin-template-design-and-react-customization.html) covers the wider setup, editing, responsive verification, lifecycle testing, harvesting, and publishing procedure."}
{"id":"BWHQ-EXT-001","title":"API-first custom service boundary","summary":"Developer custom code runs behind declared, schema-validated API endpoints so BuildWithHQ can bind custom logic into pages, workflows, AI, and external APIs without exposing platform core IP or direct unrestricted SQL.","status":"current","authority":"high","domain":"extensibility","audiences":["developer","architect","ai"],"aliases":["schema-driven API gateway","custom services","container escape hatch"],"tags":["api","custom-services","containers","extensibility"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-ARCH-003","BWHQ-EXT-002","BWHQ-SEC-001"],"path":"knowledge/extensibility/bwhq-ext-001-api-first-custom-service-boundary.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-001-api-first-custom-service-boundary.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-001-api-first-custom-service-boundary.html","content_markdown":"# API-first custom service boundary\n\n## Pattern\nWhen structured JSON configuration is not enough, a developer can implement normal code in an isolated service/container and expose stable API endpoints.\n\n## Contract\nA service version can declare endpoint keys/routes, input/output JSON schemas, required permission, execution mode, timeout, network egress policy, image digest, SBOM, and release fingerprint.\n\n## Invocation\nPages, workflows, API routes, and AI/MCP actions bind to a stable endpoint key. The platform authorization layer remains in front of the custom code.\n\n## Isolation\nCustom service code does not receive BuildWithHQ core source merely because it runs near the app, and external clients do not receive unrestricted SQL access. The contract around custom code is governed even though the code itself can use normal languages, libraries, and SDKs."}
{"id":"BWHQ-EXT-002","title":"Headless SaaS and scoped API clients","summary":"BuildWithHQ can act as a secured headless backend for external frontends, legacy systems, mobile apps, dashboards, and scripts through scoped API clients.","status":"specified","authority":"high","domain":"extensibility","audiences":["developer","sales","architect"],"aliases":["headless SaaS","headless backend","API43 concept","Headless SaaS DB"],"tags":["api","headless","legacy","integration"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-09-14","related":["BWHQ-EXT-001","BWHQ-EXT-003"],"path":"knowledge/extensibility/bwhq-ext-002-headless-saas-and-scoped-api-clients.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-002-headless-saas-and-scoped-api-clients.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-002-headless-saas-and-scoped-api-clients.html","content_markdown":"# Headless SaaS and scoped API clients\n\n## Capability\nA builder can issue scoped API clients for a SaaS application. External applications can use BuildWithHQ data/services without adopting the BuildWithHQ presentation layer.\n\n## Security model\nAPI keys/secrets are shown once, stored as hashes where appropriate, scoped, revocable, and rate-limited. API access reuses BuildWithHQ authorization, audit, and data-scope rules rather than creating a bypass.\n\n## Use cases\n- Custom web/mobile frontend hosted elsewhere.\n- Legacy application modernization while retaining the existing user interface.\n- Reporting, automation, or integration scripts.\n- External products that use BuildWithHQ as a managed data/service backend.\n- Builder-owned marketing websites that sign up a customer organization and its first owner through a trusted backend.\n\n## Customer organization signup\nA builder's verified signup backend can call the app-bound tenant-account API to create one top-level AppAccount, its first owner, protected owner authority, up to five initial DataRoles, and up to five initial Locations in one idempotent transaction. The resulting AppAccount appears in both the Builder app's Organizations directory and the tenant owner's in-SaaS account administration workspace.\n\nThe public browser never receives the live-app credential. Signup, password/passkey handling, email verification, recovery, MFA, bot defense, and login remain with the builder's identity provider and backend-for-frontend. After login, that backend exchanges the verified external organization ID and user subject for a short-lived delegated-user token with only the required module/runtime scopes.\n\n## Boundary\nHeadless access does not mean direct unrestricted database credentials. A live-app credential is server-only, has no SQL credentials or DDL/table rights, and authorizes only allow-listed routes for its bound SaaS app. Client-supplied SaaS, AppAccount, user, DataRole, or Location IDs never establish authority."}
{"id":"BWHQ-EXT-003","title":"Four MCP surfaces","summary":"BuildWithHQ’s MCP strategy separates Builder Account, Developer VM, SaaS Application, and End-Customer MCP surfaces while reusing common capability, permission, and audit primitives.","status":"specified","authority":"medium-high","domain":"extensibility","audiences":["ai","developer","builder"],"aliases":["Builder Account MCP","Developer VM MCP","SaaS Application MCP","End-Customer MCP"],"tags":["mcp","ai-tools","permissions","control-surfaces"],"source_refs":[],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-001","BWHQ-DEV-001","BWHQ-EXT-001"],"path":"knowledge/extensibility/bwhq-ext-003-four-mcp-surfaces.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-003-four-mcp-surfaces.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/extensibility/bwhq-ext-003-four-mcp-surfaces.html","content_markdown":"# Four MCP surfaces\n\n## 1. Builder Account MCP\nOperates on the builder’s BuildWithHQ account and SaaS portfolio: account administration, app portfolio, resource state, deployments, catalog interactions, and other builder-authorized capabilities.\n\n## 2. Developer VM MCP\nAssists development inside the isolated developer environment using only approved tools/gateways. It can help edit/build/test code and interact with the controlled development surface without turning unrestricted internet or production secrets into default capabilities.\n\n## 3. SaaS Application MCP\nBuilds/operates one SaaS application using that app’s authorized records, modules, workflows, APIs, AI, and management capabilities.\n\n## 4. End-Customer MCP\nExposes only the tools/actions the end customer is permitted to use inside the SaaS. Tool discovery itself should be filtered so unauthorized capabilities are not advertised.\n\n## Product model\nThe builder may package customer-facing MCP access and skills as part of the SaaS offering. All four surfaces should reuse one capability/security/audit model rather than becoming four separate authorization systems."}
{"id":"BWHQ-MOD-002","title":"Calendar first-class module","summary":"Reusable secured calendar/event records that can participate in relationships, activity, favorites, dynamic fields, and location/role-aware views.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Calendar","module.calendar"],"tags":["first-class-module","calendar","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/calendar/bwhq-mod-002-calendar-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/calendar/bwhq-mod-002-calendar-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/calendar/bwhq-mod-002-calendar-first-class-module.html","content_markdown":"# Calendar first-class module\n\n## Classification\nCalendar is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable secured calendar/event records that can participate in relationships, activity, favorites, dynamic fields, and location/role-aware views.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-008","title":"Chat rooms first-class module","summary":"Reusable chat-room and chat-message records that remain part of the universal record graph.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Chat rooms","module.chat-rooms"],"tags":["first-class-module","chat-rooms","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/chat-rooms/bwhq-mod-008-chat-rooms-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/chat-rooms/bwhq-mod-008-chat-rooms-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/chat-rooms/bwhq-mod-008-chat-rooms-first-class-module.html","content_markdown":"# Chat rooms first-class module\n\n## Classification\nChat rooms is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable chat-room and chat-message records that remain part of the universal record graph.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-005","title":"Company news first-class module","summary":"Reusable company announcement/news records built on the shared record and security model.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Company news","module.company-news"],"tags":["first-class-module","company-news","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/company-news/bwhq-mod-005-company-news-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/company-news/bwhq-mod-005-company-news-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/company-news/bwhq-mod-005-company-news-first-class-module.html","content_markdown":"# Company news first-class module\n\n## Classification\nCompany news is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable company announcement/news records built on the shared record and security model.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-001","title":"Contacts first-class module","summary":"Reusable secured people/contact records for customers, vendors, employees, contractors, prospects, and other business identities.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Contacts","module.contacts"],"tags":["first-class-module","contacts","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/contacts/bwhq-mod-001-contacts-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/contacts/bwhq-mod-001-contacts-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/contacts/bwhq-mod-001-contacts-first-class-module.html","content_markdown":"# Contacts first-class module\n\n## Classification\nContacts is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable secured people/contact records for customers, vendors, employees, contractors, prospects, and other business identities.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-004","title":"Conversations/messages first-class module","summary":"Reusable secured conversation threads and messages that can link communication directly to other business records.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Conversations/messages","module.conversations-messages"],"tags":["first-class-module","conversations-messages","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/conversations-messages/bwhq-mod-004-conversations-messages-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/conversations-messages/bwhq-mod-004-conversations-messages-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/conversations-messages/bwhq-mod-004-conversations-messages-first-class-module.html","content_markdown":"# Conversations/messages first-class module\n\n## Classification\nConversations/messages is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable secured conversation threads and messages that can link communication directly to other business records.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-009","title":"Discussion boards first-class module","summary":"Reusable boards, topics, and threaded discussion records with universal relation and security behavior.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Discussion boards","module.discussion-boards"],"tags":["first-class-module","discussion-boards","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/discussion-boards/bwhq-mod-009-discussion-boards-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/discussion-boards/bwhq-mod-009-discussion-boards-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/discussion-boards/bwhq-mod-009-discussion-boards-first-class-module.html","content_markdown":"# Discussion boards first-class module\n\n## Classification\nDiscussion boards is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable boards, topics, and threaded discussion records with universal relation and security behavior.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-013","title":"Dynamic/custom modules first-class module","summary":"Tenant-owned schema-driven modules that use typed fields and the universal RecordId/security conventions rather than bespoke tables/UI behavior.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Dynamic/custom modules","module.dynamic-custom-modules"],"tags":["first-class-module","dynamic-custom-modules","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/dynamic-custom-modules/bwhq-mod-013-dynamic-custom-modules-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/dynamic-custom-modules/bwhq-mod-013-dynamic-custom-modules-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/dynamic-custom-modules/bwhq-mod-013-dynamic-custom-modules-first-class-module.html","content_markdown":"# Dynamic/custom modules first-class module\n\n## Classification\nDynamic/custom modules is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nTenant-owned schema-driven modules that use typed fields and the universal RecordId/security conventions rather than bespoke tables/UI behavior.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-011","title":"Favorites first-class module","summary":"Reusable per-user favorites/pinning/tracking over universal records and other supported targets.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Favorites","module.favorites"],"tags":["first-class-module","favorites","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/favorites/bwhq-mod-011-favorites-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/favorites/bwhq-mod-011-favorites-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/favorites/bwhq-mod-011-favorites-first-class-module.html","content_markdown":"# Favorites first-class module\n\n## Classification\nFavorites is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable per-user favorites/pinning/tracking over universal records and other supported targets.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-003","title":"Files and attachments first-class module","summary":"Reusable secured files/attachments with universal RecordId links, backend-mediated file handling, and relation support.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Files and attachments","module.files-and-attachments"],"tags":["first-class-module","files-and-attachments","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/files-and-attachments/bwhq-mod-003-files-and-attachments-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/files-and-attachments/bwhq-mod-003-files-and-attachments-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/files-and-attachments/bwhq-mod-003-files-and-attachments-first-class-module.html","content_markdown":"# Files and attachments first-class module\n\n## Classification\nFiles and attachments is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable secured files/attachments with universal RecordId links, backend-mediated file handling, and relation support.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-016","title":"Global secured search first-class module","summary":"Reusable cross-module search that returns only records permitted by the active SaaS, tenant, role, location, and other security constraints.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Global secured search","module.global-secured-search"],"tags":["first-class-module","global-secured-search","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/global-secured-search/bwhq-mod-016-global-secured-search-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/global-secured-search/bwhq-mod-016-global-secured-search-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/global-secured-search/bwhq-mod-016-global-secured-search-first-class-module.html","content_markdown":"# Global secured search first-class module\n\n## Classification\nGlobal secured search is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable cross-module search that returns only records permitted by the active SaaS, tenant, role, location, and other security constraints.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-006","title":"Knowledge articles first-class module","summary":"Reusable knowledge-base articles that can be secured, related, searched, indexed, and exposed to permitted AI workflows.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Knowledge articles","module.knowledge-articles"],"tags":["first-class-module","knowledge-articles","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/knowledge-articles/bwhq-mod-006-knowledge-articles-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/knowledge-articles/bwhq-mod-006-knowledge-articles-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/knowledge-articles/bwhq-mod-006-knowledge-articles-first-class-module.html","content_markdown":"# Knowledge articles first-class module\n\n## Classification\nKnowledge articles is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable knowledge-base articles that can be secured, related, searched, indexed, and exposed to permitted AI workflows.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-010","title":"Mail reader first-class module","summary":"Reusable imported/read email records that can be securely related to contacts, jobs, events, files, and other records.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Mail reader","module.mail-reader"],"tags":["first-class-module","mail-reader","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/mail-reader/bwhq-mod-010-mail-reader-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/mail-reader/bwhq-mod-010-mail-reader-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/mail-reader/bwhq-mod-010-mail-reader-first-class-module.html","content_markdown":"# Mail reader first-class module\n\n## Classification\nMail reader is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable imported/read email records that can be securely related to contacts, jobs, events, files, and other records.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-012","title":"Notifications first-class module","summary":"Reusable user-targeted notifications with secured source-record context and read/dismiss state.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Notifications","module.notifications"],"tags":["first-class-module","notifications","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/notifications/bwhq-mod-012-notifications-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/notifications/bwhq-mod-012-notifications-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/notifications/bwhq-mod-012-notifications-first-class-module.html","content_markdown":"# Notifications first-class module\n\n## Classification\nNotifications is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable user-targeted notifications with secured source-record context and read/dismiss state.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-015","title":"Record activity/history first-class module","summary":"Reusable secured activity/history projection over universal records.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Record activity/history","module.record-activity-history"],"tags":["first-class-module","record-activity-history","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/record-activity-history/bwhq-mod-015-record-activity-history-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/record-activity-history/bwhq-mod-015-record-activity-history-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/record-activity-history/bwhq-mod-015-record-activity-history-first-class-module.html","content_markdown":"# Record activity/history first-class module\n\n## Classification\nRecord activity/history is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable secured activity/history projection over universal records.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-014","title":"Record relations/graph UI first-class module","summary":"Reusable UI/API surface for secured record search, bounded graph retrieval, and authorized relation creation/removal.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Record relations/graph UI","module.record-relations-graph-ui"],"tags":["first-class-module","record-relations-graph-ui","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/record-relations-graph-ui/bwhq-mod-014-record-relations-graph-ui-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/record-relations-graph-ui/bwhq-mod-014-record-relations-graph-ui-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/record-relations-graph-ui/bwhq-mod-014-record-relations-graph-ui-first-class-module.html","content_markdown":"# Record relations/graph UI first-class module\n\n## Classification\nRecord relations/graph UI is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable UI/API surface for secured record search, bounded graph retrieval, and authorized relation creation/removal.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-MOD-007","title":"Web links first-class module","summary":"Reusable shared web-resource/bookmark records participating in the same record, relation, and security system.","status":"current","authority":"high","domain":"first-class-module","audiences":["builder","developer","ai","support"],"aliases":["Web links","module.web-links"],"tags":["first-class-module","web-links","records","security"],"source_refs":["BUILD_MASTER.json — Phase 11 First-class SaaS modules","BuildWithHQ Capability, Support & AI Enablement Handbook — August 2026"],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001","BWHQ-EXT-003"],"path":"knowledge/first-class-modules/web-links/bwhq-mod-007-web-links-first-class-module.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/web-links/bwhq-mod-007-web-links-first-class-module.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/first-class-modules/web-links/bwhq-mod-007-web-links-first-class-module.html","content_markdown":"# Web links first-class module\n\n## Classification\nWeb links is a reusable **first-class BuildWithHQ runtime module**. The current Capability/Support handbook records the Phase 11 first-class module set as completed implementation evidence.\n\n## Shared first-class module contract\n- Use universal `RecordId` conventions wherever the module represents business objects.\n- Enforce SaaS/AppAccount/DataRole/location/field permissions through canonical secured procedures/services.\n- Participate in record relations, activity/history, favorites, dynamic fields, search, workflows, and AI/MCP only where those capabilities are applicable to the module.\n- Browser or AI callers use canonical module APIs; they do not perform direct table DML.\n- AI/MCP access never widens the caller’s normal authorization envelope.\n\n## Module purpose\nReusable shared web-resource/bookmark records participating in the same record, relation, and security system.\n\n## Directory purpose\nKeep this module’s architecture, API contracts, stored-procedure references, UI/runtime behavior, tests, support troubleshooting, MCP tools, and future module-specific knowledge together in this directory."}
{"id":"BWHQ-FOUND-001","title":"BuildWithHQ platform overview","summary":"BuildWithHQ is a visual SaaS operating foundation that combines reusable SaaS infrastructure, server-driven presentation, dedicated per-app data planes, AI, extensibility, marketplace distribution, and managed or self-hosted deployment.","status":"current","authority":"high","domain":"foundation","audiences":["all"],"aliases":["BuildWithHQ overview","platform thesis","SaaS operating system"],"tags":["platform","overview","saas","architecture"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-09-14","related":["BWHQ-ARCH-001","BWHQ-ARCH-003","BWHQ-MKT-001"],"path":"knowledge/foundation/bwhq-found-001-buildwithhq-platform-overview.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/foundation/bwhq-found-001-buildwithhq-platform-overview.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/foundation/bwhq-found-001-buildwithhq-platform-overview.html","content_markdown":"# BuildWithHQ platform overview\n\n## What it is\nBuildWithHQ is designed around one outcome: let a builder launch and operate a multi-tenant SaaS product without rebuilding the common substrate every time. The reusable substrate includes tenancy, permissions, billing, audit, workflows, APIs, AI data handling, deployment, and upgrades.\n\n## Core product shape\n- Visual composition handles common application structure quickly.\n- JSON-defined pages, menus, bindings, role visibility, workflows, and configuration let applications vary without a separate codebase per customer.\n- Normal code remains available through isolated custom services and APIs when the structured builder is not enough.\n- Each SaaS application is designed around dedicated operational, AI/vector, and compliance-log data planes plus isolated custom-code execution.\n- A central Template Library and marketplace distribute versioned SaaS blueprints, feature templates, custom services, and AI harnesses.\n- The same product model can run on BuildWithHQ-managed infrastructure or a self-hosted BuildWithHQ Appliance.\n\n## Current developer and presentation surface\n\nThe current Developer API publishes 273 operations across 211 paths, including 199 promoted first-class module operations. Builders and trusted developer backends can manage professional React/Puck pages, version-fenced app themes, validated custom CSS and design assets, page publication, tenant organizations and users, DataRoles, Locations, marketplace-service discovery, body-only or full-shell embedding, and 43 curated MCP tools. Asset uploads default to private and privileged application credentials remain server-side.\n\n## Important positioning boundary\nBuildWithHQ is not best described as only a no-code builder, hosting panel, vector database, workflow tool, or internal-tool canvas. It combines those concerns around the operating requirements of customer-facing SaaS."}
{"id":"BWHQ-FOUND-002","title":"Knowledge truth status and source priority","summary":"Rules for how AI should decide whether a BuildWithHQ statement is implemented, specified, planned, conceptual, deprecated, or uncertain.","status":"current","authority":"highest","domain":"foundation","audiences":["ai","developer","support"],"aliases":["truth model","source hierarchy","knowledge authority"],"tags":["knowledge","governance","status","sources"],"source_refs":[],"last_reviewed":"2026-08-27","related":[],"path":"knowledge/foundation/bwhq-found-002-knowledge-truth-status-and-source-priority.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/foundation/bwhq-found-002-knowledge-truth-status-and-source-priority.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/foundation/bwhq-found-002-knowledge-truth-status-and-source-priority.html","content_markdown":"# Knowledge truth status and source priority\n\n## Truth statuses\nEvery knowledge item must carry one of these statuses:\n- **current** — supported by the latest authoritative implementation/schema material available to this catalog.\n- **specified** — an intended contract or design has been written in sufficient detail to build against, but full production implementation is not guaranteed.\n- **planned** — accepted roadmap direction, not yet a build contract.\n- **concept** — product/architecture idea worth retaining, but not a claim about current software.\n- **deprecated** — historical behavior or terminology that should not be recommended for new work.\n- **uncertain** — evidence conflicts or is incomplete; AI must say so rather than choose silently.\n\n## Source priority\nWhen sources conflict, prefer evidence in this order unless a newer explicit decision supersedes it:\n1. Current live schema / current stored-procedure contracts / executable build state.\n2. Current implementation specifications and security contracts.\n3. Current support/developer documentation tied to the same schema generation.\n4. Current architecture briefings that reconcile against the schema.\n5. Accepted roadmap/specification discussions.\n6. Product concepts and positioning language.\n7. Older guides and legacy references.\n\n## AI behavior\nAI must never upgrade `specified`, `planned`, or `concept` into `current` merely because the idea is detailed. If answering an implementation question, identify the truth status in the answer when it matters."}
{"id":"BWHQ-GOCLAW-005","title":"GoClaw suggestion batches and human approval","summary":"GoClaw groups proposed AI actions into a suggestion batch tied to one Inbox item and its activity version, allowing BuildWithHQ to validate, review, approve, reject, or escalate the work before execution.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["suggestion batches and human approval"],"tags":["goclaw","actions","approval","suggestion-batch","human-in-the-loop"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-004","BWHQ-SEC-001"],"path":"knowledge/goclaw/actions-and-approvals/bwhq-goclaw-005-goclaw-suggestion-batches-and-human-approval.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/actions-and-approvals/bwhq-goclaw-005-goclaw-suggestion-batches-and-human-approval.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/actions-and-approvals/bwhq-goclaw-005-goclaw-suggestion-batches-and-human-approval.html","content_markdown":"# GoClaw suggestion batches and human approval\n\n## Suggestion batch\n`AiActionSuggestionBatches` is the human work package for one Inbox item. Proposed actions are validated against known action keys and input schemas before the batch is finalized.\n\n## Approval\nApproval is a permissioned action in its own right. High-risk or low-confidence work can be routed to `ReadyForApproval` or `NeedsHuman` rather than executed automatically.\n\n## Canonical GoClaw actions\nThe Build Master includes deterministic action templates such as SendConversationReply, CreateFollowup, LinkRecords, PostMessage, and UpdateRecordStatus. New actions should enter through the same governed action registry rather than private ad-hoc mutation code."}
{"id":"BWHQ-GOCLAW-006","title":"GoClaw governed action execution and stale-context fence","summary":"Approved GoClaw suggestions execute through the BuildWithHQ AI action/runtime bridge with Inbox, batch, execution, and activity-version linkage; stale context blocks finalization or execution when the underlying Inbox activity has changed.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["governed action execution and stale-context fence"],"tags":["goclaw","execution","actions","stale-context","activity-version"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-005","BWHQ-OPS-001"],"path":"knowledge/goclaw/execution/bwhq-goclaw-006-goclaw-governed-action-execution-and-stale-context-fence.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/execution/bwhq-goclaw-006-goclaw-governed-action-execution-and-stale-context-fence.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/execution/bwhq-goclaw-006-goclaw-governed-action-execution-and-stale-context-fence.html","content_markdown":"# GoClaw governed action execution and stale-context fence\n\n## Execution bridge\nApproved suggestions link to durable AI action execution records and the associated Inbox item. GoClaw’s action queue is intended to connect to that same execution path rather than form a parallel mutation mechanism.\n\n## Stale-context fence\nIf the Inbox `ActivityVersion` changes after the AI prepared its batch, BuildWithHQ should block finalization, approval, or execution as appropriate and require fresh evaluation.\n\n## Evidence\nExecution should retain correlation IDs, action/batch identity, actor identity, outcome, and enough context/evidence to support audit and support review."}
{"id":"BWHQ-GOCLAW-001","title":"GoClaw governed AI operator model","summary":"GoClaw is BuildWithHQ’s governed AI operator pattern: it works from permitted Inbox/context, prepares actions, uses approval and freshness controls, and executes through canonical action services rather than mutating data directly.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["governed AI operator model"],"tags":["goclaw","ai-operator","agent","governance"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-001","BWHQ-AI-003","BWHQ-EXT-003"],"path":"knowledge/goclaw/overview/bwhq-goclaw-001-goclaw-governed-ai-operator-model.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/overview/bwhq-goclaw-001-goclaw-governed-ai-operator-model.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/overview/bwhq-goclaw-001-goclaw-governed-ai-operator-model.html","content_markdown":"# GoClaw governed AI operator model\n\n## Role in BuildWithHQ\nGoClaw is the AI worker/operator layer associated with the Universal Inbox and the governed AI Action system. It should be treated as a participant operating under a real BuildWithHQ identity/security envelope, not as a privileged bypass around normal authorization.\n\n## Operating pattern\n1. Receive or claim eligible work from the Universal Inbox.\n2. Assemble only the context the acting identity is permitted to use.\n3. Classify intent, risk, confidence, and possible next actions.\n4. Create a suggestion batch instead of mutating application data during planning.\n5. Route the batch to approval or human handling when required.\n6. Execute approved actions through canonical BuildWithHQ action/runtime APIs.\n7. Preserve activity version, correlation, audit, and execution evidence.\n\n## Truth note\nThe current Build Master contains both completed foundations and partial/in-progress GoClaw work. This item describes the governed architecture and should not be interpreted as proof that every GoClaw workflow is production-complete."}
{"id":"BWHQ-GOCLAW-004","title":"GoClaw planning and model call","summary":"GoClaw planning uses routed AI models to classify the work, estimate risk/confidence, draft a response, and propose structured actions without performing application mutations during the planning step.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["planning and model call"],"tags":["goclaw","planning","model-routing","risk","confidence"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-003","BWHQ-AI-003"],"path":"knowledge/goclaw/planning/bwhq-goclaw-004-goclaw-planning-and-model-call.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/planning/bwhq-goclaw-004-goclaw-planning-and-model-call.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/planning/bwhq-goclaw-004-goclaw-planning-and-model-call.html","content_markdown":"# GoClaw planning and model call\n\n## Planning contract\nThe planning/model call can classify intent, estimate risk and confidence, draft a response, and propose structured actions. Planning is intentionally non-mutating.\n\n## Why this matters\nSeparating planning from execution lets BuildWithHQ validate action keys and schemas, apply permission and approval rules, and reject stale context before any write occurs. This also makes the model provider replaceable because the durable contract is the structured proposal, not a provider-specific tool call."}
{"id":"BWHQ-GOCLAW-003","title":"GoClaw secure context assembly","summary":"Before planning, GoClaw assembles a bounded context package from the Inbox source and permitted records, relationships, activity, conversations, files, calendar, knowledge, and secured RAG under one authorization envelope.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["secure context assembly"],"tags":["goclaw","context","rag","record-graph","permissions"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-002","BWHQ-AI-002","BWHQ-DATA-001"],"path":"knowledge/goclaw/secure-context/bwhq-goclaw-003-goclaw-secure-context-assembly.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/secure-context/bwhq-goclaw-003-goclaw-secure-context-assembly.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/secure-context/bwhq-goclaw-003-goclaw-secure-context-assembly.html","content_markdown":"# GoClaw secure context assembly\n\n## Context assembly\nGoClaw context is not a broad scrape of tenant data. It is assembled under the acting identity’s resolved permissions and may include the Inbox source, record graph, activity chain, conversations, files, calendar data, knowledge, and RAG results that are individually permitted.\n\n## AI rule\nThe model receives an already-permitted context set. Prompt instructions are not the security boundary.\n\n## Freshness\nContext should carry the relevant Inbox `ActivityVersion` or equivalent freshness marker so later approval/execution can detect whether the business context changed after planning."}
{"id":"BWHQ-GOCLAW-008","title":"GoClaw security and guardrails","summary":"GoClaw inherits BuildWithHQ’s server-derived identity, tenant/location/DataRole permissions, AI-specific retrieval permissions, approval controls, secret boundaries, and audit requirements; it is never a privileged bypass.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["security and guardrails"],"tags":["goclaw","security","guardrails","permissions","audit"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-001","BWHQ-SEC-001","BWHQ-AI-002"],"path":"knowledge/goclaw/security-and-guardrails/bwhq-goclaw-008-goclaw-security-and-guardrails.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/security-and-guardrails/bwhq-goclaw-008-goclaw-security-and-guardrails.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/security-and-guardrails/bwhq-goclaw-008-goclaw-security-and-guardrails.html","content_markdown":"# GoClaw security and guardrails\n\n## Non-negotiable rules\n- Derive actor, SaaS, AppAccount, role, and location context server-side.\n- Use the same secured APIs/stored procedures as other application surfaces.\n- Resolve AI-readable context before model invocation.\n- Require action-specific permission and approval where configured.\n- Do not expose hidden/encrypted fields merely because an AI is acting.\n- Do not allow direct SQL or legacy helper paths to bypass Inbox/action governance.\n- Record meaningful planning, approval, execution, and failure evidence.\n\n## Principle\nA GoClaw can be more capable than a normal screen, but it cannot be more authorized than the identity and capabilities granted to it."}
{"id":"BWHQ-GOCLAW-007","title":"GoClaw team identity and supervision","summary":"GoClaw workers can be represented as supervised team participants with explicit owning users, role membership, assignment rules, and operational state instead of anonymous system-wide bots.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["team identity and supervision"],"tags":["goclaw","team","identity","supervision","datarole"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-001","BWHQ-SEC-001"],"path":"knowledge/goclaw/team-supervision/bwhq-goclaw-007-goclaw-team-identity-and-supervision.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/team-supervision/bwhq-goclaw-007-goclaw-team-identity-and-supervision.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/team-supervision/bwhq-goclaw-007-goclaw-team-identity-and-supervision.html","content_markdown":"# GoClaw team identity and supervision\n\n## Identity\nThe current platform foundation includes Team GoClaw identity/supervision additions. A GoClaw should operate through explicit user/team/role relationships rather than a single omnipotent tenant credential.\n\n## Assignment\nInbox assignment and DataRole membership can constrain which GoClaw identity is allowed to claim work. This allows different AI operators to have different business responsibilities and data envelopes.\n\n## Supervision\nSupervision should make it possible to inspect what a GoClaw is working on, what it proposed, what awaits approval, and what actually executed."}
{"id":"BWHQ-GOCLAW-002","title":"GoClaw Universal Inbox claim loop","summary":"GoClaw work is intended to enter through the Universal Inbox, where eligible items are claimed, leased, heartbeated, and released under user/role permissions instead of being handled through a direct ungoverned inbound shortcut.","status":"specified","authority":"high","domain":"goclaw","audiences":["builder","developer","ai","support"],"aliases":["Universal Inbox claim loop"],"tags":["goclaw","universal-inbox","claim","lease"],"source_refs":["BUILD_MASTER.json — Phase 08 AI Actions & GoClaw","Platform GoClaw/Universal Inbox foundation"],"last_reviewed":"2026-08-27","related":["BWHQ-GOCLAW-001","BWHQ-SEC-001"],"path":"knowledge/goclaw/universal-inbox/bwhq-goclaw-002-goclaw-universal-inbox-claim-loop.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/universal-inbox/bwhq-goclaw-002-goclaw-universal-inbox-claim-loop.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/goclaw/universal-inbox/bwhq-goclaw-002-goclaw-universal-inbox-claim-loop.html","content_markdown":"# GoClaw Universal Inbox claim loop\n\n## Canonical boundary\nInbound work should enter GoClaw through the Universal Inbox. The Build Master explicitly calls for retiring legacy direct inbound helpers that could bypass the Inbox and suggestion-batch approval path.\n\n## Claim behavior\nThe worker claim loop is designed around `sp_Inbox_ClaimForGoClaw`, lease/heartbeat behavior, and assigned-role checks. If an Inbox item carries an assigned DataRole, the GoClaw owning user must belong to that role before claim.\n\n## Safety invariant\nClaiming an Inbox item grants work ownership, not unrestricted data access. Every downstream record, relation, file, message, or AI retrieval still uses the normal authorization envelope."}
{"id":"BWHQ-MKT-001","title":"Template Library and marketplace","summary":"The BuildWithHQ Template Library is a versioned software catalog for SaaS blueprints, feature templates, custom services, and AI harnesses with entitlements and exact-version installation.","status":"current","authority":"high","domain":"marketplace","audiences":["builder","developer","sales"],"aliases":["Template Library","marketplace","software supply chain"],"tags":["templates","marketplace","versions","entitlements"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_Stored_Procedure_Reference_2026-08.pdf"],"last_reviewed":"2026-09-14","related":["BWHQ-ARCH-004","BWHQ-AI-004","BWHQ-EXT-001"],"path":"knowledge/marketplace/bwhq-mkt-001-template-library-and-marketplace.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/marketplace/bwhq-mkt-001-template-library-and-marketplace.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/marketplace/bwhq-mkt-001-template-library-and-marketplace.html","content_markdown":"# Template Library and marketplace\n\n## Artifact families\n- SaaS Blueprints: complete starting applications.\n- Feature Templates: pages, components, modules, data models, or workflows added to an app.\n- Custom Services: signed/versioned isolated services with declared endpoint contracts.\n- AI Harnesses: versioned AI behavior and evaluation artifacts.\n\n## Marketplace mechanics\nProducts can have versions/components/offers/prices. Buyers receive entitlements and can assign/install the purchased artifact into owned SaaS apps. Existing customers can remain on the exact version they installed while newer versions become optional upgrades.\n\nSeller earnings and payout requests remain auditable in the BuildWithHQ ledger. Eligible transfers use Stripe Connect; Stripe controls provider processing and the connected account's bank-payout timeline. BuildWithHQ documentation must not promise a separate fixed bank-arrival date.\n\n## Strategic role\nThe catalog is the software supply chain that keeps managed and self-hosted deployments coherent. Solved vertical patterns can become reusable inventory rather than one-off consulting work."}
{"id":"BWHQ-OPS-001","title":"Dedicated logging, audit, and evidence plane","summary":"Each SaaS can maintain a separate logging/compliance database for append-oriented record changes, AI retrieval evidence, authorization context, custom-service events, and integrity-chain data.","status":"current","authority":"high","domain":"operations","audiences":["security","ops","ai"],"aliases":["compliance log DB","logging plane","flight recorder"],"tags":["logging","audit","compliance","evidence"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_Stored_Procedure_Reference_2026-08.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-002","BWHQ-SEC-003"],"path":"knowledge/operations/bwhq-ops-001-dedicated-logging-audit-and-evidence-plane.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-001-dedicated-logging-audit-and-evidence-plane.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-001-dedicated-logging-audit-and-evidence-plane.html","content_markdown":"# Dedicated logging, audit, and evidence plane\n\n## Separation\nHeavy compliance/history writes and long-horizon analysis are kept separate from the live transactional database.\n\n## Evidence types\nThe logging plane can include record changes, AI query/retrieval evidence, authorization context, sensitive disclosure, custom-service/appliance events, and tamper-evident chain data.\n\n## Design properties\n- Append-oriented rather than ordinary mutable application state.\n- Integrity can be protected with hash chaining/tamper detection.\n- Read/reveal/export/AI decisions can be logged in addition to writes.\n- History remains associated with the tenant/application and can participate in customer-owned export/analytics workflows.\n\n## Support value\nCorrelation IDs and structured metadata let support connect user-visible failures with backend/provisioning/audit evidence without exposing secrets to the browser."}
{"id":"BWHQ-OPS-002","title":"Domains, API clients, backups, integrations, and asynchronous operations","summary":"Builder-facing domain, credential, backup, and integration changes use scoped stored procedures/services; long-running verification and execution work is asynchronous.","status":"current","authority":"high","domain":"operations","audiences":["developer","ops","support"],"aliases":["deep app operations","app operations"],"tags":["domains","api-clients","backups","integrations"],"source_refs":["BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx"],"last_reviewed":"2026-08-27","related":["BWHQ-BUILDER-001","BWHQ-SEC-003"],"path":"knowledge/operations/bwhq-ops-002-domains-api-clients-backups-integrations-and-asynchronous-operations.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-002-domains-api-clients-backups-integrations-and-asynchronous-operations.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-002-domains-api-clients-backups-integrations-and-asynchronous-operations.html","content_markdown":"# Domains, API clients, backups, integrations, and asynchronous operations\n\n## Domains\nDomains are added/removed/set-primary through scoped procedures. DNS/SSL verification can run asynchronously.\n\n## API clients\nThe backend generates high-entropy secrets, stores only safe derived data such as hashes where appropriate, and displays the raw secret once. Rotate/revoke operations are audited.\n\n## Backups\nA backup request creates pending work. A worker executes it and updates status. Backup destinations are managed through scoped procedures and should avoid long-lived plaintext cloud credentials.\n\n## Integrations\nSensitive integration secrets are encrypted before database persistence and omitted from list/detail responses.\n\n## General rule\nLong-running infrastructure actions should expose queued/provisioning/running/failed states and correlation IDs rather than block an interactive browser request."}
{"id":"BWHQ-OPS-003","title":"Stripe and billing source-of-truth boundaries","summary":"BuildWithHQ reconciles Stripe payment/subscription state into SQL for entitlements and display while treating Stripe as authoritative for external payment objects and keeping end-SaaS billing separate from platform billing.","status":"current","authority":"high","domain":"operations","audiences":["billing","developer","support"],"aliases":["Stripe reconciliation","platform billing"],"tags":["stripe","billing","webhooks","idempotency"],"source_refs":["BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx"],"last_reviewed":"2026-08-27","related":["BWHQ-BUILDER-001"],"path":"knowledge/operations/bwhq-ops-003-stripe-and-billing-source-of-truth-boundaries.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-003-stripe-and-billing-source-of-truth-boundaries.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/operations/bwhq-ops-003-stripe-and-billing-source-of-truth-boundaries.html","content_markdown":"# Stripe and billing source-of-truth boundaries\n\n## Platform billing\nThe central control plane tracks the BuildWithHQ builder/customer subscription, invoices, payments, refunds, checkout state, and resource add-ons.\n\n## Stripe boundary\nStripe owns external customer/subscription/invoice/payment/refund/payment-method state. SQL stores identifiers and a reconciled projection used for entitlements, capacity, audit, and support.\n\n## Required mechanics\n- Verify webhook signatures before database processing.\n- Deduplicate and make processing idempotent/order-tolerant.\n- Do not treat a browser redirect as proof of payment.\n- Do not expose raw Stripe secrets or full payment data.\n\n## Separation\nBilling that a builder charges the end customers of a generated SaaS belongs to that SaaS application data plane, not the BuildWithHQ platform billing ledger."}
{"id":"BWHQ-PROD-001","title":"ActiveWorkplace","summary":"ActiveWorkplace is a proposed workspace that pins a record and projects its permitted recursive relationship graph, participants, activity, work state, and AI collaborators into one active operational view.","status":"specified","authority":"medium","domain":"product","audiences":["builder","product","ai"],"aliases":["Pinned Recursive Active Record Graph Workplace","Active Workplace","Pinned Record Graph"],"tags":["activeworkplace","records","graph","collaboration"],"source_refs":[],"last_reviewed":"2026-08-27","related":["BWHQ-DATA-001","BWHQ-SEC-001"],"path":"knowledge/product/bwhq-prod-001-activeworkplace.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/product/bwhq-prod-001-activeworkplace.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/product/bwhq-prod-001-activeworkplace.html","content_markdown":"# ActiveWorkplace\n\n## Concept\nActiveWorkplace is not a separate copied silo. It is an active projection over real BuildWithHQ records and their permitted recursive relationships.\n\n## Core elements\n- A **Pinned Record** anchors the workspace.\n- The system expands a bounded, permission-aware recursive active graph from that record.\n- Human participants, workflows, and GoClaw/AI participants can appear with explicit responsibilities and permissions.\n- Activity can be summarized as a **Record Pulse**, with states such as Active, Waiting, At Risk, Stale, Dormant, or Resolved.\n- A Universal Inbox can bring actionable work into the workspace.\n- Graph Playback can reconstruct how the active record graph evolved over time.\n\n## Security\nGraph traversal never implies permission. Each node/edge included in the projection must already be permitted for the viewer/agent."}
{"id":"BWHQ-PROD-002","title":"CompanyIQ","summary":"CompanyIQ is a proposed permission-aware company intelligence layer that combines embedded company knowledge with operational data to surface answers, opportunities, and recurring insights.","status":"concept","authority":"medium","domain":"product","audiences":["builder","ai","sales"],"aliases":["Company IQ","company intelligence"],"tags":["companyiq","rag","insights","knowledge"],"source_refs":[],"last_reviewed":"2026-08-27","related":["BWHQ-AI-002","BWHQ-AI-001"],"path":"knowledge/product/bwhq-prod-002-companyiq.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/product/bwhq-prod-002-companyiq.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/product/bwhq-prod-002-companyiq.html","content_markdown":"# CompanyIQ\n\n## Concept\nCompany documents, manuals, policies, and other knowledge can be chunked/embedded, then combined with permitted operational records such as sales history, pending deals, customers, and activity.\n\n## Experience\nUsers can ask questions against the company’s knowledge and business data. Scheduled AI analysis can surface patterns, risks, customer opportunities, and follow-up ideas.\n\n## Required architecture\nCompanyIQ should not create a separate broad-access data lake. It should inherit BuildWithHQ’s permission-aware retrieval, source provenance, tenant/application scope, and AI-specific permissions. Daily or scheduled insights must run under a defined service identity and permission envelope."}
{"id":"BWHQ-SEC-001","title":"Security invariants","summary":"Security is designed as a shared structural layer: server-derived identity, one authorization path, explicit tenant/application/location scope, and separate permissions for read, AI, export, and sensitive disclosure.","status":"current","authority":"highest","domain":"security","audiences":["developer","security","ai"],"aliases":["authorization invariants","server-derived identity","DataRoles"],"tags":["security","authorization","identity","permissions"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-002","BWHQ-SEC-003","BWHQ-AI-002","BWHQ-EXT-003"],"path":"knowledge/security/bwhq-sec-001-security-invariants.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-001-security-invariants.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-001-security-invariants.html","content_markdown":"# Security invariants\n\n## Invariants\n- Identity and account/application context come from verified authentication and server-side resolution, not ordinary browser fields.\n- Record visibility is resolved through common security primitives such as roles/capabilities and location scope rather than each feature inventing a separate permission model.\n- UI JSON, hidden buttons, prompts, and client-side filtering cannot grant access.\n- Read, AI processing, export, and secure-field reveal can be distinct capabilities.\n- Secrets and sensitive credentials are never treated as ordinary application data.\n\n## Service boundary\nBrowser-facing identities should execute safe procedures/API contracts and should not receive privileged provisioning/billing identities or direct unrestricted table DML.\n\n## AI implication\nAn AI tool or MCP adapter inherits the same permission envelope. Tool discovery and retrieved context should be narrowed by authorization before the model acts."}
{"id":"BWHQ-SEC-002","title":"Replayable authorization and tamper-evident evidence","summary":"BuildWithHQ’s security design aims to preserve enough historical authorization state and logged evidence to reconstruct whether past sensitive access was valid.","status":"current","authority":"high","domain":"security","audiences":["security","compliance","ai"],"aliases":["authorization replay","security replay","hash chain"],"tags":["audit","replay","temporal","evidence"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf"],"last_reviewed":"2026-08-27","related":["BWHQ-OPS-001","BWHQ-AI-002"],"path":"knowledge/security/bwhq-sec-002-replayable-authorization-and-tamper-evident-evidence.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-002-replayable-authorization-and-tamper-evident-evidence.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-002-replayable-authorization-and-tamper-evident-evidence.html","content_markdown":"# Replayable authorization and tamper-evident evidence\n\n## Purpose\nA normal audit trail can prove that access occurred. Replayable authorization aims to answer whether the access should have been allowed under the rules that applied at the time.\n\n## Evidence model\nSensitive retrievals can log a fingerprint of the resolved authorization envelope plus retrieval evidence into tamper-evident history. Permission-bearing state can retain temporal history so membership, roles, locations, and record state can be reconstructed.\n\n## Replay modes\n- **As of then:** reconstruct historical rules and compare them with the logged authorization proof.\n- **As of now:** apply current rules to the same historical event to detect permission drift.\n\n## AI use\nThis is especially relevant to questions such as whether an AI system ever received context that was outside the caller’s permitted envelope."}
{"id":"BWHQ-SEC-003","title":"Secure fields, secrets, and disclosure","summary":"Sensitive values can be structurally excluded from normal search/AI paths, with decryption or disclosure treated as a separate privileged and auditable operation.","status":"current","authority":"high","domain":"security","audiences":["developer","security","ai"],"aliases":["secure fields","encrypted fields","secret handling"],"tags":["encryption","secrets","disclosure","ai-exclusion"],"source_refs":["BuildWithHQ_Investor_Technical_Briefing_August_2026.pdf","BuildWithHQ_SaaS_Builder_Portal_AI_Implementation_Spec_v1_2.docx"],"last_reviewed":"2026-08-27","related":["BWHQ-SEC-001","BWHQ-OPS-001"],"path":"knowledge/security/bwhq-sec-003-secure-fields-secrets-and-disclosure.md","markdown_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-003-secure-fields-secrets-and-disclosure.md","html_url":"https://buildwithhq.com/BuildWithHQ_Knowledge_Catalog_v0.1/knowledge/security/bwhq-sec-003-secure-fields-secrets-and-disclosure.html","content_markdown":"# Secure fields, secrets, and disclosure\n\n## Secure fields\nA secure custom field stores encrypted content and cryptographic metadata. Plaintext is not left available to every downstream subsystem.\n\n## Consequences\n- Secure values are excluded from ordinary search indexing.\n- Secure values are excluded from AI retrieval by storage/processing design, not merely by prompt instructions.\n- Reveal/decrypt is an explicit privileged action and can be audited, including denied attempts.\n\n## Secrets\nRaw refresh tokens, invitation tokens, password-reset tokens, API client secrets, MFA recovery values, Stripe secrets, and integration credentials must not be persisted as ordinary plaintext. Prefer hashes for one-time authentication tokens and a secret vault/encrypted service boundary for credentials that must later be used."}