Menus

  • Published on Feb 4, 2026
  • 1 minute(s) read
Prev Next

Overview

The menu system allows users to navigate to different areas of the mobile app. It provides access to different features and workflows you deem important to the user’s needs. This information is accessible via the collapsed menu icon (☰).

Menus are specified in your authentication response.

How It Works

The platform allows you to create multiple menus for different types of users. For example, a user in one division could see a different menu than a user in another division. This assignment happens when a user logs in. The menu is specified in your authentication response. There are two ways to do this:

  1. Return a string for the menu_code property

    • Use this string to reference a menu you have built and saved in App Manager, as it is the most common approach

  2. Dynamically build the entire Menu inside the API response itself

    • This is done by providing a full menu object, which contains an array of all menu items and properties to display

NOTE: The authentication response must include either menu or menu_code. When providing both, the inline menu object will always take precedence.

Key Components

When building a menu using the inline menu object, you will work with several menu items.

Menu Items

Each item on the Menu has a specific function and appearance.

The available menu items are:

  • home: Home screen

  • messages: Messages list

  • browser: Launch a web browser, either embedded inside the app or an external browser, if specified

  • load-list: Load list

  • news: News list

  • transaction-editor: Show form for sending form-based messages

  • documents-list: Documents list

  • settings: Settings screen

  • telephone: Prompt to call a telephone number

  • submenu: A nested secondary menu with additional item types

     NOTE: Only two menu levels are supported because the behavior of a submenu containing another submenu is undefined

  • scan-flow: Launches a scan flow

  • screen: Displays a dynamic action screen

  • todo: Display TODO items pending completion

  • payroll: Display Payroll information for the user

  • media-library: Displays a Media Library

  • hours-of-service: Displays hours of service telematics information

  • launch-url: Launches the app (if installed) or directs the user to the App Store/Play Store to install it

  • logout: Log the user out of the app

Resources

API