Sitemap
All pages
Every article on this site — 179 across 14 sections. Search at the top of any page is usually faster, but this is the full map.
Getting Started
Create your account, launch your first app, and understand how the platform is put together.
What is BuildWithHQ?The platform in plain terms: build, brand, and resell your own SaaS applications.What makes BuildWithHQ differentSeven differences you could verify in the database schema — and what each one means for your day.Ten questions to ask any platform (including us)Take these into every vendor evaluation. Our answers are below, each linked to its documentation. We suggest asking everyone else for theirs in writing.Create your accountSign up, verify your email, and secure your account before creating anything.Launch your first appCreate an application and understand what gets provisioned when you do.Manage customer organizationsCreate and administer every customer organization inside one SaaS app.Connect a custom domainPoint your own domain at your application and get automatic TLS.Invite your teamAdd teammates to the builder console and control what they can do.A tour of the three consolesChoose the Admin, Developer, or Operations workspace without changing identity or permissions.
Console Guides
Find the right workspace for account administration, product development, and operations—using one identity and the permissions you already have.
Three consoles, one BuildWithHQ identityHow Admin, Developer, and Operations divide navigation without dividing authentication or authorization.Admin Console guideManage the business and governance layer behind every SaaS app from hello.buildwithhq.com.Developer Console guideBuild apps, publish exact versions, configure integrations, and use the developer platform from dev.buildwithhq.com.Operations Console guideOperate running SaaS workloads with bounded health, provisioning, backup, domain, log, analytics, and AI evidence.
How-To Do This
Build each Build This product as a secure, operable SaaS solution first; package a reusable exact-version template only after it passes production checks.
How to build CrewOSBuild a governed team of specialized AI operators with shared records, approval boundaries, and replayable execution evidence.How to build SignalIQBuild account signals, explainable scoring, deal-risk views, and approved next-best actions over connected revenue records.How to build ResolveBuild a permission-aware support operation that identifies customers, retrieves policy, proposes safe resolutions, and escalates exceptions.How to build LaunchPilotBuild a campaign cockpit for audiences, governed AI assets, approvals, channel activation, experiments, and optimization.How to build NorthstarBuild evidence-backed executive metrics, material-change signals, forecasts, scenarios, and replayable briefings.How to build TeamBoxBuild a shared communications command center with channel normalization, AI triage, ownership, suggestions, and governed execution.How to build RelateEverythingBuild a CRM where people, companies, work, communications, files, and custom records reveal their connected context.How to build CustomerPortalBuild a branded customer workspace that shares selected requests, files, messages, approvals, and milestones while protecting internal work.How to build CompanyIQBuild permission-aware document search and scheduled intelligence that connects knowledge to customers, risks, and opportunities.How to build OpsAtlasBuild an owned, revisioned operating-memory product with permission-aware answers, evidence, review work, knowledge gaps, and governed actions.How to build Headless SaaS DBBuild a managed, permission-aware SaaS backend for custom web, mobile, desktop, or existing frontends.How to build CaseFlowBuild controlled case stages, intake, work queues, documents, decisions, approvals, SLAs, and replayable history.How to build AssetOpsBuild customer, location, asset, inspection, work-order, technician, parts, and service-history operations.How to build ActiveWorkplaceBuild a Wave-like shared coordination surface around any permitted Record and its secured recursive relationship graph.How to build FieldServiceBuild customer, service-area, scheduling, job, estimate, approval, evidence, and follow-up operations for field teams.How to build ReservationsBuild bookable products, capacity, assignments, calendars, tenant-controlled payments, and pre/post-service follow-up.How to build Support TicketsTurn selected inbound email addresses into durable support-ticket queues inside Universal Inbox.How to build Checkoff & ApprovalBuild reusable checklists whose items can require notes, documents, photos, and governed approval before work is accepted.
First Class Modules
Explore native platform features and every bundled tenant-runtime module—what each does, where it fits, and the server-enforced boundary it keeps.
Universal InboxCollects configured external email, optional support tickets, SMS, web-form submissions, and other inbound communications into one secured attention layer where unsorted work stays visible and routing rules can classify, prioritize, assign, and queue it for action.Checklists & SignoffsAttaches reusable, versioned checklists to authorized records and lets each item require notes, documents, or photos before the completed run enters the existing Workflow signoff path.GoClaw virtual assistantAdds a dedicated virtual assistant to a user account that researches, summarizes, classifies, drafts, and proposes work without ever receiving more access or action authority than that user.AI InsightsRuns permission-aware AI analysis in the background each day to create prioritized, evidence-backed insights and governed next actions from meaningful changes in authorized business records.ContactsProvides a secured contact directory with configurable contact types, search, create/detail experiences, custom fields, relationships, activity, and favorites.Work OrdersTracks work requests through a secured lifecycle with number, customer, location, summary, priority, status, assignments, related records, and service evidence.ReservationsTurns a bookable product purchase into one secured workflow: contact identity, capacity-protected reservation, protected charge, calendar event, tenant-user assignment, resource booking, and scheduled before/after-service follow-up.CalendarProvides secured month/agenda scheduling for events, attendees, resources, reminders, locations, private events, custom fields, relationships, activity, and favorites.Files & attachmentsProvides private file upload, download, metadata, tags, record attachments, comments, locks, custom fields, relationships, activity, and favorites without exposing storage coordinates.Conversations & messagesProvides native channel threads with participants, messages, status, priority, internal notes, outbound replies, related context, activity, dynamic fields, and favorites.Company newsPublishes searchable internal announcements with draft, scheduled, published, and expired visibility, author controls, custom fields, relationships, activity, and favorites.Knowledge CoreTurns tenant knowledge into owned, revisioned, reviewable records that connect to business context, answer questions, support permission-aware AI/RAG, and learn safely from resolved support work.Web linksMaintains searchable, categorized, location-aware external links with descriptions, custom fields, relationships, activity, and favorites.Chat roomsProvides secured team rooms with messages, unread state, membership, room administration, mute settings, reactions, archives, custom fields, relations, activity, and favorites.Message ForumsProvides boards, topics, threaded posts, replies, pin/lock moderation, archives, owned-post editing, custom fields, relations, activity, and favorites.Mail readerProvides a read-focused view across authorized personal/shared mail accounts with search, unread filtering, plain-text message detail, read state, relations, activity, dynamic fields, and favorites.FavoritesGives each user a secured cross-module list of saved records with search, module filters, pinning, change tracking, related context, activity, and dynamic fields.NotificationsProvides recipient-scoped alerts with unread filtering, detail, dismissal, source-record context, relations, activity, and source favorites.Dynamic/custom recordsRenders tenant-owned custom modules from their validated field schema with secured list, search, create, detail, edit, status, relations, activity, and favorites.ActiveWorkplacePins any permitted Record into a collaborative workplace over its secured recursive relationship graph, with people, GoClaws, workflows, Record Pulse, Inbox attention, activity, and read-only Graph Playback.Record relationsExplores authorized records as a bounded relationship graph and supports typed relation creation/removal only when both endpoints are editable.Record activityShows a paged, filterable, chronological activity timeline for an authorized record with actor, event type/state, date range, relations, and favorite state.Global secured searchSearches permitted records across modules and also uses permission-filtered vector retrieval to find meaningfully related information in indexed uploads, PDFs, images, screenshots, tables, diagrams, and text.CompanyIQ evidence searchSearches approved company records and multimodal sources with citations, and queues only already-authorized records for ingestion.OpsAtlas operating memoryShows Knowledge Core health, answers operating questions from authorized published evidence, captures unsupported questions as gaps, and queues approved records for multimodal indexing.
Builder Guide
Design pages, manage templates, automate with workflows, and put AI to work — everything you do day to day.
Build and publish SaaS pagesBuild inside your SaaS with Puck, preview safely, and publish an exact validated draft.React component catalog and copy/paste kitCopy styled or unstyled React starters for all first-class capabilities, native page modules, Universal Inbox, GoClaw, menus, shell layouts, data bindings and exact API contracts.Professional Template FoundationBuild polished, responsive SaaS pages from registry-backed components, copyable compositions, token-safe themes and server-scoped data bindings.Support for ReactUse Tailwind, ordinary CSS, CSS Modules, inline styles, component libraries, or CSS-in-JS with your React frontend.Apply a TailAdmin-style design and customize every React pageSet up an owned CSS and token system from a licensed React template, refine shared components, edit each SaaS page in Puck, and publish the finished design safely.Host SaaS CSS, logos, images, and design assetsUpload app-scoped assets, organize virtual folders, publish validated CSS, and use stable public asset URLs in pages and React templates.Convert HTML into BuildWithHQ/Puck pagesTurn static HTML or a frontend build entry into deterministic, validated Professional Foundation page JSON without importing arbitrary code or authority.Run Puck locally and assign data bindingsOpen canonical BuildWithHQ page JSON in a self-contained local Puck editor, assign registered binding keys, and save a validated unpublished draft without exposing credentials to Vite.Interactive API presentations for professional admin pagesBuild API-bound KPI strips, names and statuses, progress, charts, sortable grids and timelines from one bounded server-scoped presentation contract.Headless application guide and copy/paste kitBuild a custom frontend over BuildWithHQ authentication, scoped APIs, first-class modules, Inbox, Workflow, Files and exact server-side authorization.Monaco advanced JSON modeEdit the canonical page document directly in Monaco with the same validation and publish fences.Templates, forks, and upgradesStart from a template, customize freely, and still receive upstream improvements.Menus and User TypesCreate a User Type, assemble its menu from shared or independent pages, and publish safely.WorkflowsAutomate multi-step processes on your data: branching, approvals, waits, and AI steps.Universal InboxExternal email, SMS, web forms, and other inbound communications in one attention layer—unsorted or routed, always actionable.The AI assistantA per-user assistant that drafts, triages, and acts — always inside an approval queue you control.GoClaw in depth: acting on a user's behalf, under controlThe complete control stack that lets the assistant do real work without ever being able to run away with it.Rating GoClaw and improving resultsEvery action can be rated, every suggestion explains itself — so poor results can be diagnosed, not just endured.Build with AIDescribe the product you want in a guided interview and get a drafted, working application.Secure fieldsPer-field encryption for your most sensitive data — and what it deliberately turns off.Marketplace and add-onsInstall extensions into your apps — from single components to complete bundles.Appliances and their endpointsHow container appliances declare what they do, what they can reach, and why none of it can change after release.Connecting to external servicesThe four ways your app talks to the outside world, and how outbound credentials are kept safe.Your container and Postgres databaseExtend an app with custom services and a separate Postgres store when the required compute environment is provisioned.Snowflake analytics sync (tenant-operated)Each tenant can ship their own logging history into their own Snowflake warehouse — their data, their warehouse, their analytics.Build with ActiveWorkplaceAdd and configure the recursive work module without creating a second record or permission system.Harness PacksTest AI behavior configurations against scored scenarios before they touch real customers.Upgrade DB: staged database inventoryReview missing database dependencies before preparing a controlled SaaS upgrade.
Selling Templates
Turn what you've built into products: open a storefront, publish templates, and get paid — with the platform handling checkout, entitlements, and payouts.
From your app to the storefrontThe whole seller journey in one page: what you'll set up, in what order, and why each step exists.Becoming a sellerOpen your storefront and connect payouts — the one-time setup before anything can be listed.Preparing a template for saleWhat “ready to sell” means: a published version, clean validation, and licensing you actually have.Products, versions, and offersThe three-layer listing model, the four billing models, and the activation checklist.Getting paidOrder math, the seller ledger, Stripe Connect payout submission, and provider-controlled delivery timing.Managing products after launchShipping new versions, honoring existing buyers, refunds, and retiring products well.
Inspirations to Build From
Familiar products, rebuilt as your own: the data model, the pages, and the automation each one needs — plus the angle that makes your version better than the original.
Build a white-label agency CRMAn agency platform with isolated client sub-accounts, pipelines, and communication history — sold under your own brand.Build a HubSpot-style CRM and marketing systemContacts, deals, and lifecycle stages tied together with the automations that actually move a pipeline.Build a Salesforce-style custom business applicationNot a Salesforce clone — a custom-object database with the permission depth serious operations need, built without starting from scratch.Build a visual sales pipelineThe clearest starting project: a Kanban pipeline, a contact directory, and the drag-to-advance automation that makes a sales CRM feel alive.Build a sales engagement and sequencing systemMulti-step outreach sequences with branching, reply detection, and automatic enrollment — the engine behind Outreach- and Salesloft-style tools.Build a work management platformOne reusable foundation — projects, tasks, and views — that becomes Basecamp, Trello, Asana, monday.com, ClickUp, or Wrike depending on which views and fields you emphasize.Build an engineering issue trackerOne issue-tracking foundation, configured two ways: strict and reportable like Jira, or fast and minimal like Linear.Build a relational data app like AirtableArguably the platform's own best demo: user-defined tables and fields, multiple views, and the automations that turn a spreadsheet into an application.Build a hierarchical project sheet like SmartsheetRow hierarchies, formulas, and Gantt views for teams who think in spreadsheets but need approvals and cross-sheet reporting.Build a document-database hybrid like CodaDocuments that embed live database views, buttons, and formulas — software that reads like a page instead of a spreadsheet.Build a multi-brand support desk like ZendeskTicketing with SLA timers, routing, and knowledge management — a strong early build because the data model is straightforward and the commercial case is obvious.Build a customer messaging platform like IntercomA website messenger, shared inbox, and AI-answered support — grounded in your own knowledge base and gated by real permissions.Build a conversational form builder like TypeformOne-question-at-a-time forms with branching logic and payment steps — an excellent early project with a JSON-simple data model.Build an enterprise survey platform like QualtricsAdvanced branching, scoring, and role-restricted reporting for research-grade surveys — with clear limits on what stays in scope.Build a multi-channel marketing automation platformSegments, flows, and campaign attribution — one blueprint that covers Klaviyo, Mailchimp, and ActiveCampaign-style automation.Build a real-time engagement platform like Braze or DriftThe advanced layer on top of marketing automation: real-time triggers, in-app messaging, and live chatbot playbooks.Build an API orchestration and enrichment tool like ClaySpreadsheet rows with enrichment columns that call external providers, with waterfall fallback logic and full credit tracking — a strong demo of the platform as an orchestration layer.Build a prospecting and enrichment portalThe application layer over sales intelligence data — filters, target lists, and alerts — built on top of providers who own the underlying data network.Build a call intelligence platform like GongCall records, transcripts, and coaching — with the heavy media processing kept where it belongs.Build a team messaging system like SlackChannels, threads, and searchable history are a natural fit — but be honest about what production-grade real-time messaging actually requires.Build a video messaging app like LoomThe SaaS wrapper around video — folders, comments, and AI summaries — with capture and streaming left to specialized infrastructure.
Using Your App
Guides for the people who use applications built on the platform. White-label friendly — share or rebrand these for your customers.
About this section (for builders)How to reuse these end-user guides under your own brand.Signing in and your accountAccess your workspace, reset a password, and keep your account secure.Administer your tenant accountInvite hosted users, manage external users, DataRoles, locations, User Type menus, and a live account-scoped developer kit.Your inboxWork conversations and optional support tickets from every channel in one place.AI suggestions and approvalsWhat the assistant does, what it never does without you, and how to review its work.Your insights feedWhat the AI has noticed in your data, ranked by priority — and how to keep the feed yours.Records, fields, and searchFind, view, and edit information — and why some fields behave differently.Coordinate work in ActiveWorkplacePin a record, follow its connected work, coordinate participants, and review its history.How everything connectsEvery piece of information is a record, records link across every module, and relationships are always visible from both sides — so you never have to guess what belongs to what.What's New and FavoritesCatch up on changes across any date range, and follow the records you care about.NotificationsWhat the bell counts and how to keep it useful.Back up and download your dataYour data is yours — the account owner can create a complete, verified copy of it at any time. It is never trapped here.
Developer Platform
Build against your SaaS with the app-scoped Developer API, webhooks, connectors, AI, logs, MCP tools, the CLI, and secure installed services.
API MapEvery first-class and Build This route, with complete lifecycle and usability coverage.Choose your developer kit and versionDownload the current public kit, understand version numbers, or get a kit scoped to your tenant account.Developer platform overviewOne permission-aware developer surface for records, connectors, events, AI, logs, MCP, and installed services.Build a complete headless SaaSUse every promoted first-class module from your own React, mobile, desktop, or legacy interface without exposing an API credential to the browser.How customer organizations can signup from your websiteConnect your SaaS marketing-site signup and login to one governed BuildWithHQ customer organization and its first owner.Build This API recipesEighteen complete, contract-backed API slices for BuildWithHQ and API43 product concepts.Developer API quickstartCreate an app-scoped credential, verify its identity, make a first record request, and retain correlation evidence.REST APIsThe current resource-oriented v1 API for app identity, records, connectors, webhooks, AI, logs, contracts, and installed services.Authentication and API clientsUse isolated draft credentials for unpublished page JSON and an explicit live credential for publication and production operations.Requests, responses, errors, and correlation IDsThe conventions every client should apply for JSON, pagination, safe errors, retries, and operational evidence.Permission-aware data accessEvery data surface resolves through the same record, role, location, and capability envelope.Connectors, OAuth, and provider secretsDiscover supported connector types and configure data, payment, and OAuth connections without sending raw provider secrets.Inbound endpointsCreate app-bound inbound entry points, rotate keys, and process incoming events through authenticated application APIs.Webhooks and event deliveryPush signed application events to external systems with retries, idempotency, and observable delivery history.Webhook receiver and background-job polling examplesRun the exact-body webhook receiver and bounded AI rebuild poller published at webhooks.buildwithhq.com.Logs, diagnostics, and correlation tracingTail and search bounded app logs, then follow one correlation ID across related operational evidence.AI ingestion, rebuilds, and multimodal searchUse the secured tenant AI surface for authorized record ingestion, rebuild operations, and Qwen3-VL search.Database contract lock filesGenerate, diff, and verify safe schema signatures without exposing tables, stored procedures, DSNs, or database credentials.Workflows and custom actionsBuild durable server-side automations from native actions, approvals, waits, webhooks, AI actions, and extension services.MCP tools for AI clientsExpose approved API-backed application capabilities to MCP-compatible AI clients under the same permission envelope.Use BuildWithHQ with DeepSeek HarnessConnect DeepSeek Harness to the curated BuildWithHQ MCP surface with a tested Streamable HTTP patch, app or delegated-user identity, and exact tool-name mapping.Marketplace service API discoveryDiscover installed custom endpoint schemas, download per-app OpenAPI, and let MCP agents plan governed calls.Extensible container servicesAdd custom code in an isolated container, then expose it through declared endpoints the BuildWithHQ runtime can safely invoke.BuildWithHQ CLIUse the shipped .NET 10 CLI for profiles, app delivery, templates, services, API clients, workers, AI, logs, and contract locks.OpenAPI, versioning, and SDKsKeep the API reference, schemas, generated clients, and changelog synchronized from one canonical contract.Pagination, filtering, rate limits, and versioningImplement list traversal, server-side filters, 429 recovery, and contract pinning from the exact OpenAPI operation.Limits, rate limits, and idempotencyHow clients should handle quotas, throttling, payload boundaries, retries, and safely repeated writes.Integration go-live checklistA practical review for credentials, scopes, retries, webhooks, observability, test isolation, and operational ownership.
Errors & Troubleshooting
Look up any error code, and walk through fixes for the most common problems.
Error code referenceEvery code the platform can show you, what it means, and what to do.Can't sign inLockouts, expired links, unverified accounts, and MFA trouble.Domain and certificate problemsVerification stuck, certificate warnings, and wrong-site symptoms.Page won't save or publishValidation errors, edit locks, and the E021 identity gate.Getting helpWhat to check first, what to include when you write in, and where.
Billing & Account
Plans, payments, what happens when a payment fails, and how account lifecycle works.
Plans and trialsHow trials end, what plans include, and how to change plans.Invoices and receiptsFind, download, and understand your invoices.When a payment failsThe grace period, what gets restricted, and how to restore service.Charging your customersCollect payment from your tenants through the platform's payment rails.Cancel or close your accountWhat cancellation does, when it takes effect, and what happens to data.
Partners & MSPs
The partner program for managed service providers: resell, deploy on your own hardware, and earn on every builder you bring.
Partner program overviewHow MSP partnership works: attribution, earnings, and what you operate.Deploying the partner applianceRun the AI appliance on your own hardware: enrollment, connectivity, and requirements.Deploy the SaaS asset domain and storage rootConfigure persistent asset storage and route assets.buildwithhq.com to the tenant runtime without exposing database or filesystem authority.How appliance updates workSigned updates, health-gated switchover, and what to do if one fails.
Trust & Security
How the platform isolates, protects, and accounts for your data — written for the person evaluating us.
Security architectureThe structural guarantees: isolation, a single enforcement point, and identity that can't be spoofed.Tenant Data SecurityHow User Types, DataRoles, and Locations work together to shape an app experience and protect tenant data.User Types: menus and SaaS pagesUser Types define the menu, landing experience, and SaaS app pages each kind of person is shown.DataRoles: data and action permissionsDataRoles define what tenant data a person can see, add to, change, delete, export, or use through approved AI paths.Locations: where tenant data is assignedLocations define where records belong and whether a person works across all, one, or multiple tenant locations.EncryptionIn transit, at rest, and per-field — including tenant-specific keys.TDS 8.0 and SQL Server 2025 transport securityHow BuildWithHQ protects service-to-database traffic with SQL Server 2025, TDS 8.0, strict encryption, and layered authorization.Audit trail and data disclosureThe immutable history of what happened, and the verifiable ledger of third-party access.Tenant logging: the immutable recordA dedicated, append-only history of what happened — built so it can be verified, not just trusted.Replayable authorization: rewinding a security decisionAny past AI data access can be re-derived and re-checked — as of then, and as of now.Battle test: multiple tenants in a BuildWithHQ SaaSHow BuildWithHQ's first-class modules and APIs behaved with multiple tenants, scoped users, and hostile cross-tenant requests.Data lifecycle, residency, and portabilityHow customer data is isolated, exported, backed up to customer-owned storage, and assigned to an enterprise deployment.Business continuity and application portabilityHow applications can relocate to AWS or Azure, or be restored in a cloud or virtual machine if BuildWithHQ shuts down.
Release Notes
What's new, what changed, and anything you need to act on.