Implementing NLWeb on HubSpot CMS

Open project for turning websites into natural-language and agent-accessible interfaces. This guide is specific to HubSpot CMS teams shipping production integrations.

Back to NLWeb Back to protocol collection

Why this implementation exists

NLWeb standardizes how an AI host discovers tools, resources, and prompts from external systems so each integration is not custom-built per client.

Treat HubSpot serverless functions as the trusted protocol execution layer and keep CMS templates focused on user-facing output.

Protocol-specific implementation focus

Normalize structured content before exposing query interfaces.
Track source attribution for every generated answer segment.
Route ambiguous intents to deterministic fallback UX.

HubSpot CMS technical foundation

HubSpot CMS themes/modules for presentation and structured component reuse.
HubDB and CMS APIs for content retrieval and controlled updates.
Serverless functions for privileged operations and external API orchestration.
Private app tokens and scoped permissions for secure automation paths.

Step-by-step production rollout

Scope the target journey. Pick one high-value flow where NLWeb adds deterministic value and define success metrics (latency, completion rate, human override rate).
Build a protocol adapter service. Keep NLWeb logic in a dedicated adapter layer, separate from CMS templates and page rendering concerns.
Map protocol contracts to HubSpot CMS primitives. Define read/write boundaries and strict schemas before implementation starts.
Add authentication and policy gates. Enforce least-privilege tokens, role checks, and explicit approval points for sensitive operations.
Implement idempotency + retries. Make long-running operations safe for replay, and include request IDs for traceability.
Instrument observability. Log capability calls, validation failures, latency, and user escalations with protocol-level correlation IDs.
Run conformance + integration tests. Validate schema contracts, permission boundaries, and rollback behavior before production.
Roll out progressively. Start with read-only capability exposure, then enable controlled writes, then full orchestration.

Security and governance controls

Use environment-scoped secrets and rotate credentials for HubSpot CMS integrations on a fixed cadence.
Treat protocol payloads as untrusted input; validate all schemas before execution.
Record human approvals and denied operations for post-incident audits.
Apply explicit write allowlists for NLWeb actions that mutate HubSpot CMS content or commerce state.
NLWeb services should gate sensitive/private content at index and retrieval time.

Validation checklist

Serverless endpoint contract tests for schema, auth, and error handling.
Content publish workflow tests for draft vs live parity.
Rate-limit and retry tests for API-heavy orchestration paths.

Common failure modes and mitigations

Pushing privileged actions into client-side HubL/JS without serverless mediation.
Over-broad private app scopes applied to protocol adapters.
Lack of clear separation between content rendering and orchestration services.