Custom components—referred to as Workflows, Forms, or Screens—are modular UI elements built using the App Builder. They consist of structured menus, rows, and cells, allowing for advanced front-end interactions and support for complex user flows.
These components are visually designed within the App Builder and cannot be created via API. However, APIs can interact with them in real time to deliver dynamic and integrated user experiences.
✅ Capabilities
Once a component is designed in the builder, the API can:
- Write values to cells dynamically using
updateMenuCell
- Receive user interactions (inputs, button presses, selections) via
menuCallback
- Use the component menus to build integrated forms, multi-step workflows, and custom logic-driven screens
🔸 menuCallback — Read User Input
When a user interacts with a component menu (e.g., selects an item, presses a button, submits input), a
menuCallback is sent to your API via WebSocket.This interaction format is identical to callbacks from inline and chat menus.
📘 See menuCallback in the Menus section for the complete structure.
Component ObjectupdateMenuCell — Write to Component CellsmenuCallback — Read User Input