Appearance
Platform Glossary & Page Reference
Canonical names for every page and concept in the Cavai platform. Use these terms consistently in code, documentation, and conversation.
Hierarchy
Enterprise
└── Workspace
├── Brand (user-facing: "Client")
│ └── Campaign
│ └── Creative Group
│ └── Creative
│ ├── Blocks (visual elements)
│ ├── Flow (interaction logic)
│ └── Delivery (targeting & serving)
├── Reports
└── TemplatesCore Concepts
| Term | Also Called | Definition |
|---|---|---|
| Enterprise | Account, Organization | Top-level billing/admin entity. Contains workspaces. |
| Workspace | — | Operational context. All content is scoped to a workspace. Users switch between workspaces. |
| Brand | Client | A customer/advertiser. Contains campaigns. User-facing label is "Clients" in navigation. |
| Campaign | — | A marketing initiative under a brand. Contains creative groups. |
| Creative Group | — | A collection of related creatives (e.g., different sizes/variants). |
| Creative | Chatbot (legacy code name) | An interactive ad unit. The core product artifact. Code still uses Chatbot in many places (pages, store, components). |
| Block | Element | A visual component inside a creative (text, image, button, video, etc.). |
| Operator | Flow Node | A logic node in the flow editor (ShowHide, Redirect, Delay, etc.). |
| Template | Creative Template | A reusable creative starting point saved at workspace level. |
Pages
Shell & Navigation
| Component | Canonical Name | Description |
|---|---|---|
PageBase.vue | App Shell | The authenticated layout wrapper. Contains the top navigation bar, context switcher, user menu, breadcrumbs, and renders the active page. Not a page itself — it's the chrome around every page. |
| Top navigation bar | Nav Bar | Horizontal bar at the top with logo, primary nav links, context switcher, user avatar. |
| Context switcher | Context Switcher | Dropdown in the nav bar for selecting active enterprise and workspace. |
Primary Navigation Pages
These are the main pages accessible from the nav bar:
| Route | Canonical Name | Code Name | Description |
|---|---|---|---|
/ | Home / Dashboard | MainPage | Landing page with tiles showing recent creatives, reports, campaigns, brands. |
/workspaces/:id/brands | Clients | Brands | List of brands/clients in the workspace. Nav label is "Clients". |
/workspaces/:id/campaigns | Campaigns | Campaigns | List of campaigns in the workspace. |
/workspaces/:id/reports | Reports | Reports | List of saved reports with tabs (favorites, workspace, user, deleted). |
/workspaces/:id/creative-templates | Templates | CreativeTemplates | Saved creative templates for the workspace. |
/workspaces/:id/recent-creatives | Recent Creatives | CreativeRecentListPage | Recently modified creatives across the workspace. |
/workspaces/:id/accounts | Users | Accounts | User management for the workspace. |
/user-settings | User Settings | UserSettings | Personal profile, password, API tokens. |
/trash | Trash | Trash | Soft-deleted items with restore capability. |
Drill-Down Pages
| Route | Canonical Name | Code Name | Reached From |
|---|---|---|---|
/workspaces/:id/brands/:brandId/campaigns | Brand Campaigns | Campaigns | Clicking a brand |
/workspaces/:id/campaigns/:campaignId/creative-groups | Creative Groups | CreativeGroups | Clicking a campaign |
/workspaces/:id/creative-groups/:groupId/creatives | Creatives | Chatbots (legacy) | Clicking a creative group |
Creative Builder
The builder is the primary workspace for creating and editing creatives. It's a single page with multiple tabs/modes:
| Route | Canonical Name | Code Name | Description |
|---|---|---|---|
/creatives/:id/build | Builder | ChatbotBuilder | Full creative editor |
Builder Tabs (internal views):
| Tab | Canonical Name | Description |
|---|---|---|
| Dialogue tab | Visuals / Design | Block editor — add, arrange, and style visual elements. Contains the configuration panel (right sidebar) and the creative preview (center). |
| Flow tab | Flow | Interaction logic editor — connect operators to define user journeys. |
| Delivery tab | Delivery | Targeting, serving settings, and tag/embed code. |
Builder Panels:
| Panel | Canonical Name | Description |
|---|---|---|
| Left sidebar | Block List | Tree of all blocks in the creative. |
| Center | Preview | Live preview of the creative in an iframe. |
| Right sidebar | Configuration Panel | Property editor for the selected block. Contains cards with sections (e.g., Size, Position, Font, Colors). |
Admin Pages
| Route | Canonical Name | Description |
|---|---|---|
/enterprises | Enterprises | Enterprise list (enterprise+ users). |
/workspaces | Workspaces | Workspace list / context switcher. |
/global/accounts | Global Users | System-wide user management (super admin). |
Dialogs & Overlays
| Component | Canonical Name | Description |
|---|---|---|
AssetLibraryDialog | Asset Library | Modal for browsing, uploading, and selecting brand/campaign assets (images, fonts, videos). |
CreativeWizard | Creative Wizard | Step-by-step flow for creating a new creative from a template. |
TextInputDialog | Rename Dialog | Generic single-input confirmation dialog. |
ConfirmDialog | Confirm Dialog | Generic yes/no confirmation. |
Scope Levels
Content in the platform is scoped to different levels:
| Level | Scope | Example |
|---|---|---|
| Global | Entire platform | Super admin views, system settings |
| Enterprise | One enterprise | Enterprise-level reports, user management |
| Workspace | One workspace | Most daily work happens here |
| Brand | One client | Brand assets, brand-level creative groups |
| Campaign | One campaign | Campaign assets, campaign creative groups |
| Creative | One creative | Blocks, flow, delivery settings |
Legacy Code Names
Some code still uses older names. The mapping:
| Legacy Code Name | Current Canonical Name |
|---|---|
Chatbot / ChatbotBuilder | Creative / Builder |
ChatbotsPage | Creatives list page |
Brands (nav) | Clients |
routeCreativeId | Creative ID (was "chatbot ID") |