Back to buildwithhq.com

Platform guide · 2026-10-23

What you can do with BuildWithHQ

Build, brand and operate SaaS products with published pages, connected records and governed automation.

Build and publish your product

Compose React pages in the Puck page designer, configure themes, assets, menus and User Types, and publish a reviewed page version. User Types select the experience; DataRoles and Locations control access to business records. A saved draft is separate from the version customers see.

Read the guide

Choose who can see each record

For records that support Personal, explicitly choose Personal or an eligible DataRole. Personal records belong to their owner and have no location. Chat Rooms, Discussion Boards, Knowledge, Company News and Files are shared-only: choose one DataRole. For shared records, choose an authorized location or All when permitted; a blank location is not All. Child records inherit their parent’s scope. A shared record cannot be converted to Personal.

Read the guide

Work across connected business modules

Use the enabled app modules for contacts, organizations, work orders, tasks, checklists, conversations, files and knowledge. Availability and allowed create, view, edit and removal actions depend on the published app, entitlement and your permissions. Search and activity views lead back to the native record; removal may archive or deactivate records to preserve history.

Read the guide

Keep attention and source records together

Universal Inbox brings work needing attention into one place while conversations, form submissions and business records remain their original sources. Refresh a changed item before approving an action. GoClaw research and planning are read-only; material changes require the configured approval policy and permission for the specific action.

Read the guide

Use AI within your access

AI search and Knowledge Core use the current user’s record, field, DataRole, location and AI-read permissions before assembling context. Multimodal retrieval can retain document text and visual evidence. Model serving, ingestion and execution workers must be configured and enabled; seeing an AI control does not establish that a provider or worker is running.

Read the guide

Connect your own interface and tools

Use the current generated OpenAPI reference and versioned Developer Kit for headless apps, typed clients, webhooks and supported MCP tools. Keep app credentials on a trusted server. Delegated user identity, scopes and action permissions still apply. Sensitive MCP tools require app-level approval; installing an MCP client does not grant write access.

Read the guide

Manage integrations deliberately

Configure connections and credentials for the intended app and organization, verify the connection, then explicitly enable the supported workflow or schedule. Mail delivery, payment processing, Snowflake export and background jobs depend on their configured providers and workers. A queued receipt is not delivery, bank settlement or completed execution.

Read the guide

Investigate safely with + Debug

Authorized builders can open + Debug to inspect safe outcomes, timing and correlation references, then follow a problem into app Logs. Share the sanitized support export rather than customer payloads, tokens or screenshots of secrets. Closing a problem preserves its history, and later occurrences can reopen it.

Read the guide

Provision and extend an app

An app has routed Core, Logs and AI database planes. Provisioning is a staged operation: wait for readiness and any reported setup requirements before inviting customers. Marketplace presentation installs are pinned snapshots; upgrading a template is explicit. Customer-hosted Appliance operation and optional extension compute have their own deployment requirements.

Read the guide

Keep team chat inside its membership

Chat rooms and messages require current room membership as well as DataRole and location access, including when opened through Graph, Activity or Favorites. Find them in native Chat Rooms search; general and AI search exclude chat content. Administrators add eligible members, and saves check current authority again. Room removal preserves history through soft deletion; an authorized restore does not revive independently removed messages.

Read the guide

Check the capability you plan to use

Use your app’s current published pages, permissions and readiness messages to confirm availability. The generated API reference describes public API operations; the module inventory distinguishes product surfaces. These guides do not certify every deployment, provider connection or feature as production ready.

Current support guide · Service status