Custom Components — also known as Workflows, Forms, or Screens — are modular UI blocks designed using the App Builder. They are composed of structured menus, rows, and cells, enabling powerful frontend interactions for complex flows.
Components are created and structured visually using the App Builder. They cannot be created via API, but the API can interact with them in real-time to build dynamic, integrated 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.
Let me know if you'd like this styled for Notion, Markdown, or API Blueprint — or if you want visual flow diagrams to go with it.
Component ObjectupdateMenuCell — Write to Component CellsmenuCallback — Read User Input