Chatbox
Embed your agent chat experience inside an app screen.
The Chatbox component lets you place the Budibase chat experience directly inside your app.
It uses the same chat setup from Agent chat, including agent availability, access roles, defaults, and conversation starters.
Before you start
Make sure you have:
- Completed Agents config
- Enabled at least one live agent in Agent chat
- Verified chat access from Agents -> Deployment -> Open chat
Add the Chatbox component
- Open your app under Apps
- Click Add component
- Open the AI category
- Select Chatbox
You can then resize and position the component like other screen components.
Chatbox settings
| Setting | Description |
|---|---|
| Intro text | Short text shown above the conversation area. |
| Input placeholder | Placeholder text in the chat input box. |
| Send button label | Label shown on the send action button. |
Styling
Chatbox supports:
- Padding
- Background
- Border
For best results, give Chatbox enough vertical space so users can view history and compose messages comfortably.
Runtime behavior
In app runtime, Chatbox:
- Loads enabled agents from the workspace chat configuration
- Uses the configured default agent for starting new chats
- Shows per-agent conversation starters when configured
- Hides unavailable agents from the enabled list
If no agents are configured or enabled, users see an empty-state message instead of a chat session.
Access and availability
Agent availability in Chatbox depends on Agent Chat configuration:
- Agent must be enabled in chat settings
- Agent should be live
- User must meet the configured access role
- Chat route must be available in the App Portal
Update these from Agent chat if a component appears but users cannot start conversations.
Troubleshooting
If Chatbox is visible but not usable:
- Confirm chat opens from Agents -> Deployment -> Open chat
- Confirm at least one live agent is enabled in Agent Chat
- Confirm your user role has access to the selected agent
- Re-open the app after publish to load the latest chat settings
Related guides
Updated about 4 hours ago