A Menu is a structured container used to organize and display one or more rows of interactive elements called cells. Each menu defines a UI layout that can be rendered as part of a mobile app screen, section, or tab.
Menus serve as flexible building blocks in the app builder and can be used for:
- Displaying dynamic forms or content blocks
- Triggering API actions through button presses
- Navigating between screens or components
- Collecting and submitting user input
Each menu must contain at least one row, and each row can contain one or more cells arranged horizontally. Menus can also include configuration options such as background styling, images, templates, navigation logic, and API bindings.
Additionally, menus can be embedded in chats in two ways:
- As inline menus attached to a specific message
- As keypad menus, allowing persistent interaction within a chat window
Menus are uniquely identified by
menu_id, and can be grouped or versioned for better management and integration.Field | Type | Required | Access | Description |
menu_id | String | Yes | đĸ Writable | Unique local identifier for the menu. Used internally to manage and reference menus. |
menu_group | String | Yes | đĸ Writable | Logical grouping ID to group related menus under a tab or category. |
menu_name | String | Optional | đĸ Writable | Display the name of the menu. Used internally for easier identification by developers during menu management. |
menu_version | String | Optional | đĩ Read-only | Auto-generated version string. Updated when the menu is modified. |
menu_order | Number | Optional | đĸ Writable | Sort the order of the menu within its group or tab. If not provided, it defaults to 0. Used to determine the display sequence when multiple menus are grouped. |
cat | String | Option | đĩ Read-only | Category label used to classify the menu (e.g., menu, store). |
rows | Yes | đĸ Writable | Set of rows containing the cell buttons. At least one row is required. |