Integration Overview
Choose how to connect to Busabase through the browser, CLI, SDK, MCP, OpenAPI, agent skills, events, automation, or imports.
Connect to the same workspace from whichever tool fits your work. You can combine methods: an agent writes through MCP, a person works in the browser, and a script reads merged records through the SDK.
Choose a method
The Channel column in Insights records how a contribution arrived. Follow its link to the matching guide.
| Channel | Use it for | Start here |
|---|---|---|
Web UI (web_ui) / Browser (browser) | Browse and edit in your browser | Browser quick start |
CLI (cli) | Terminal work, scripts, and CI | Install and connect the CLI |
SDK (sdk) | TypeScript / JavaScript or Python applications, scripts, and notebooks | TypeScript SDK · Python SDK |
MCP (mcp) | Give your agent tools through its MCP client | MCP connection and OAuth |
OpenAPI (openapi) | HTTP integrations in any language | OpenAPI and REST |
Skill (skill) | Teach your agent the Busabase workflow | Install agent skills |
Webhook (webhook) | React to workspace events | Webhooks and events |
Automation (automation) | Run a recurring or event-driven workflow | Automation |
Import (import) | Bring in a package or restore a backup | Import |
Skills teach an agent how to work; CLI, MCP, and HTTP provide the connection it uses. A webhook sends an event to another system, which can then use CLI, SDK, or REST to act on the workspace.
Automation
For a recurring job, run the CLI, SDK, or REST API from your own scheduler or CI workflow. For event-driven work, configure Webhooks and events. The automation channel identifies a contribution's source; it does not configure a schedule.
Start with read-only calls, verify the target workspace, and use Change Requests when your workflow proposes edits. Grant only the permissions it needs in API keys.
Import
To install a reusable workspace package from GitHub, follow Install and export, preview what it will create, and review its proposed content. To restore a full backup into an empty workspace, follow Busabase dump.
Workflow platforms
- n8n: install the community node
n8n-nodes-busabaseunder Settings → Community Nodes. It reads and writes Bases and records, docs, folders, files, and playbooks, searches the workspace, and can start a workflow when a record is created or updated. Source: github.com/busabase/n8n-nodes-busabase. - Dify: install the Busabase plugin from the Dify Marketplace to let workflows, chatflows, and agents read the workspace, follow its playbooks, and write back as Change Requests.
Both connect with an API key. Writes are Change Requests: they merge right away when the key has write access and wait for review otherwise.
Verify your connection
For Cloud, choose the account, API key or OAuth grant, and target workspace before reading or writing. The CLI guide covers sign-in and workspace selection; SDK and REST use the same base URL, key, and workspace id. Local and self-hosted connection details are documented in each guide.
Other ways to connect: Integration overview · CLI · SDK · Python SDK · MCP · OpenAPI / REST · Agent Skills · Webhooks