Properties
| Property | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Display name of the app. |
slug | string | Yes | Identifier (a–z, 0–9, -); unique. settings is reserved and cannot be used. |
icon | string | No | Icon shown for the app. |
description | string | No | What the app is for. |
taxonomies | array | No | Categories used to organize apps. |
navigation | array | No | The navigation menu. |
overview | object | No | The home / overview page. |
active | boolean | No | Whether the app is live. Activating an app validates its configuration first. |
Navigation
Navigation is a hierarchical menu: top-level groups, each holding children that link to a section and one of its layout pages. A child can optionally deep-link to a specific record or to a Single Record page.| Navigation field | Purpose |
|---|---|
title | Group label. |
icon | Group icon. |
children | The links in the group. |
children[].section + layout page | The section and layout page the link opens. |
children[].record | Optional — deep-link straight to one record. |
Home / overview
The overview is the app’s landing page — a banner and a set of featured shortcuts:- Banner — an image from the DAM shown across the top.
- Featured layout pages — quick-access cards to the section pages users reach most often.
Inboxes & funnel reports
An app can surface two cross-cutting kinds of content alongside its sections:- Inboxes — conversation inboxes attached to the app, so a team can work conversations from inside their workspace.
- Funnel reports — the app references one or more Engagement Funnels; a funnel report layout page then renders their analytics, driven by the funnels the app links to.
Activating an app
Setting an app toactive makes it available to its users. Before an app goes live, CXF
validates its configuration — its navigation references, attached inboxes, and
overview must resolve correctly — so users never open a broken app.
Related
Journey Manager Apps
Back to the feature overview.
Sections
The data units an app’s navigation points to.