Overview
A Sitemap is a visual way to plan and document a digital product built on CXF — a web app, a mobile app, or an MCP server. On an interactive canvas you map the product’s pages, connect them with navigation edges, and fill each page with sections and components. You then link CXF resources — endpoints, funnels, and events — to any node, so the diagram records which resources power which parts of the product. For the bigger picture, see Core concepts.Where to find it
Sitemaps live under Docs explorer → Sitemaps.Structure
A sitemap is a canvas of pages connected by edges. Each page contains a list of sections and components:| Node | Role |
|---|---|
| Page | A top-level screen/route — the nodes you see and connect on the canvas. |
| Section | An optional grouping inside a page. |
| Component | A piece of a page — directly on the page, or nested inside a section. |
What’s on a node
Every page, section, and component carries:| Property | Description |
|---|---|
label | Display name — unique among its siblings. |
status | Planned, In progress, Live, or Deprecated. |
relative_url | (Pages) The page’s path, e.g. /home — combined with the sitemap’s per-environment base URL. |
description | Rich-text (markdown) notes. |
cxf_resources | The linked endpoints, funnels, and events. |
Linking CXF resources
Attach endpoints, funnels, and event templates to any node to document what powers it. A resource-usage lookup then answers the reverse question: which sitemaps and nodes reference this endpoint / funnel / event?Environments & URLs
A sitemap stores a base URL per environment (for exampleproduction and
development); each page adds a single relative path. The canvas has an
environment selector that previews each page’s external link for the selected
environment.
Sitemap properties
| Property | Type | Description |
|---|---|---|
name | string | The sitemap’s name. |
description | string | Optional description. |
platform | enum | web, mobile, or mcp (descriptive). |
status | enum | draft, active, or archived. |
urls | object | Base URL per environment. |
nodes / edges | array | The pages (with their sections and components) and the edges between them. |
Search & deep-linking
Toolbar search spans every page, section, component, and linked resource (accent-insensitive), and always returns the matching node. Every node is deep-linkable, so you can share a link straight to a specific page, section, or component.Export
Download a full sitemap as a structured PDF or Markdown document. Linked resources are resolved to their real definitions — an endpoint lists its parameters (established defaults vs caller-exposed), and funnels and events get a short summary — so the export doubles as product documentation.Seeds
Seeds support for sitemaps is coming soon.Governance & permissions
Only a super admin or Master can create, edit, and delete sitemaps.API access
Sitemaps have full CRUD through the User API, plus the resource-usage lookup and the Markdown/PDF export operations. See the API reference.Related
APIs Playground
The endpoints you link to nodes.
Engagement Funnels
Funnels you link to nodes.
Events & Automation
Events you link to nodes.
Activities
Collaborate on each node.