# Botstar

```json
{
  "name": "Botstar",
  "slug": "botstar",
  "url": "https://composio.dev/toolkits/botstar",
  "markdown_url": "https://composio.dev/toolkits/botstar.md",
  "logo_url": "https://logos.composio.dev/api/botstar",
  "categories": [
    "sales & customer support"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:03:49.150Z"
}
```

![Botstar logo](https://logos.composio.dev/api/botstar)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Botstar MCP or direct API to fetch bot analytics, send messages, update bot flows, and manage conversations through natural language.

## Summary

BotStar is a comprehensive chatbot platform for designing, developing, and training chatbots visually on Messenger and websites. It helps businesses automate conversations and customer interactions without coding.

## Categories

- sales & customer support

## Toolkit Details

- Tools: 31

## Images

- Logo: https://logos.composio.dev/api/botstar

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Botstar.
  - Setup:
    - Configure Api Key credentials for Botstar.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Open live chat widget for new visitor
- Update user profile in current chat session
- Retrieve chatbot application ID for setup
- Send order confirmation from webview to bot

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `BOTSTAR_CREATE_BOT` | Create Bot | Tool to create a new bot in BotStar. Use when you need to create a new bot instance with a specific name. |
| `BOTSTAR_CREATE_BOT_ATTRIBUTE` | Create Bot Attribute | Tool to create a new bot attribute in BotStar. Bot attributes are global variables for a bot and support multilingual values. Use when you need to define custom data fields for your bot. |
| `BOTSTAR_CREATE_CMS_ENTITY` | Create CMS Entity | Tool to create a CMS entity in BotStar with a name and optional fields. Use when you need to define a new content structure with custom fields supporting various data types. |
| `BOTSTAR_CREATE_ENTITY_FIELDS` | Create Entity Fields | Tool to create entity field(s) in BotStar CMS. Supports multiple field types including text, multiple_values, single_option, multiple_options, image, date, and entity. Use when you need to add new fields to an existing entity. |
| `BOTSTAR_CREATE_ENTITY_ITEM` | Create Entity Item | Tool to create a new entity item in BotStar CMS. Use when adding items to a CMS entity with custom field values. |
| `BOTSTAR_CREATE_USER_ATTRIBUTES` | Create User Attributes | Tool to create custom user attributes in BotStar. Use when you need to define new custom attributes for users with specified field name and type. |
| `BOTSTAR_DELETE_BOT_ATTRIBUTE` | Delete Bot Attribute | Tool to delete a bot attribute by ID. Use when you need to remove a custom attribute from a bot. |
| `BOTSTAR_DELETE_CMS_ENTITY` | Delete CMS Entity | Tool to delete a CMS entity by ID. Use when you need to remove an entity from the bot's content management system. |
| `BOTSTAR_DELETE_ENTITY_FIELDS` | Delete Entity Fields | Tool to delete entity field(s) from a CMS entity. Use when you need to remove fields from a CMS entity by their unique names. |
| `BOTSTAR_DELETE_ENTITY_ITEM` | Delete Entity Item | Tool to delete an entity item from a CMS entity. Use when you need to remove a specific item from a bot's CMS entity. |
| `BOTSTAR_GET_BOT` | Get Bot | Tool to get your bot by bot ID. Use when you need detailed bot information including ID, name, and team name. |
| `BOTSTAR_GET_BOT_APP_ID` | Get BotStar Application IDs | Tool to retrieve the BotStar application ID (`appId`). Use when initializing or reinitializing the live chat widget. |
| `BOTSTAR_GET_CMS_ENTITY` | Get CMS Entity | Tool to get a specific CMS entity by ID. Returns entity details including fields configuration. Use when you need to retrieve metadata about a CMS entity structure. |
| `BOTSTAR_GET_ENTITY_ITEM` | Get Entity Item | Tool to retrieve a specific item from a CMS entity with all field values. Use when you need to get detailed information about a single entity item. |
| `BOTSTAR_LIST_BOT_ATTRIBUTES` | List Bot Attributes | Tool to get all bot attributes from BotStar. Returns array of bot attributes with id, name, desc, value, and data_type. Use when you need to retrieve or inspect all attributes configured for a bot. |
| `BOTSTAR_LIST_BOTS` | List Bots | Tool to get your list of bots. Use when you need to retrieve all bots associated with your account. Returns an array of bots with their id, name, and team_name. |
| `BOTSTAR_LIST_CMS_ENTITIES` | List CMS Entities | Tool to retrieve all CMS entities for a bot. Use when you need to access entity definitions, field configurations, or available entity schemas. |
| `BOTSTAR_LIST_ENTITY_ITEMS` | List Entity Items | Tool to retrieve all entity items with pagination support. Use when you need to list CMS entity items, with optional filtering by name and status. |
| `BOTSTAR_LIVECHAT_BOOT` | Livechat boot | Tool to reinitialize the live chat widget with provided data. Use after initial load to reset or update widget configuration. |
| `BOTSTAR_LIVECHAT_CLOSE` | Close BotStar Livechat Widget | Tool to hide the live chat window. Use when the chat widget is configured in livechat or popup mode. |
| `BOTSTAR_BOTSTAR_LIVECHAT_ON_CLOSE` | BotStar LiveChat onClose Callback | Tool to register a callback when the chat window is closed. Use after the widget is initialized. Example prompt: "Register an onClose handler that logs 'Goodbye!' to the console." |
| `BOTSTAR_LIVECHAT_ON_OPEN` | Livechat on open | Tool to register a callback when the chat window is opened. Use after widget initialization. |
| `BOTSTAR_LIVECHAT_OPEN` | Livechat open | Tool to show the live chat window. Use after the widget has been bootstrapped with BotStarApi('boot') to programmatically open the chat window (mode must be 'livechat' or 'popup'). |
| `BOTSTAR_LIVECHAT_UPDATE` | Livechat update | Tool to update user details on the current live chat session. Use when you need to modify user profile attributes during an active conversation. |
| `BOTSTAR_PUBLISH_BOT` | Publish Bot to Live | Tool to publish a bot to live. Use when you need to deploy changes to the production environment. |
| `BOTSTAR_UPDATE_BOT_ATTRIBUTE` | Update Bot Attribute | Tool to update a bot attribute in BotStar. Use when you need to modify the description or value of a bot attribute with optional multilingual support. |
| `BOTSTAR_UPDATE_CMS_ENTITY` | Update CMS Entity | Tool to update a CMS entity in BotStar. Use when you need to modify the name or configuration of an existing CMS entity. |
| `BOTSTAR_UPDATE_ENTITY_FIELDS` | Update Entity Fields | Tool to update entity field(s) in BotStar CMS. Use when you need to modify the name or options of existing fields. |
| `BOTSTAR_UPDATE_ENTITY_ITEM` | Update Entity Item | Tool to update a CMS entity item in BotStar. Use when you need to modify the name, status, or custom field values of an entity item. |
| `BOTSTAR_WEBVIEW_GET_PARAMETER` | Get BotStar Webview Parameter | Tool to retrieve a parameter value passed from the BotStar chatbot to the webview. Use inside onChatBotReady after your page loads in modal mode with bs:input meta tags. |
| `BOTSTAR_WEBVIEW_SEND_RESPONSE` | Webview send response | Tool to send data from the webview back to the BotStar chatbot. Use when you need to transmit responses or custom outputs from an open webview. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Botstar Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Botstar actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': '[A real, concrete use case specific to {TOOLKIT_NAME}]'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: '[A real, concrete use case specific to {TOOLKIT_NAME}]'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Botstar tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Open the BotStar live chat window for the website visitor')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Open the BotStar live chat window for the website visitor' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Botstar Integration

- Supports both Botstar MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Botstar data

### 2. Managed Auth

- Built-in API key handling with secure storage
- Central place to manage, scope, and revoke Botstar access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Botstar
- Scoped, least privilege access to Botstar resources
- Full audit trail of agent actions to support review and compliance

## Use Botstar with any AI Agent Framework

Choose a framework you want to connect Botstar with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/botstar/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/botstar/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/botstar/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/botstar/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/botstar/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/botstar/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/botstar/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/botstar/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/botstar/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/botstar/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/botstar/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/botstar/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/botstar/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/botstar/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/botstar/framework/autogen)

## Related Toolkits

- [Aeroleads](https://composio.dev/toolkits/aeroleads) - Aeroleads is a B2B lead generation platform for finding business emails and phone numbers. Grow your sales pipeline faster with powerful prospecting tools.
- [Autobound](https://composio.dev/toolkits/autobound) - Autobound is an AI-powered sales engagement platform that crafts hyper-personalized outreach and insights. It helps sales teams boost response rates and close more deals through tailored content and recommendations.
- [Better proposals](https://composio.dev/toolkits/better_proposals) - Better Proposals is a web-based tool for crafting and sending professional proposals. It helps teams impress clients and close deals faster with slick, easy-to-use templates.
- [Bidsketch](https://composio.dev/toolkits/bidsketch) - Bidsketch is a proposal software that helps businesses create professional proposals quickly and efficiently. It streamlines the proposal process, saving time while boosting client win rates.
- [Bolna](https://composio.dev/toolkits/bolna) - Bolna is an AI platform for building conversational voice agents. It helps businesses automate support and streamline interactions through natural, voice-powered conversations.
- [Botsonic](https://composio.dev/toolkits/botsonic) - Botsonic is a no-code AI chatbot builder for easily creating and deploying chatbots to your website. It empowers businesses to offer conversational experiences without writing code.
- [Callerapi](https://composio.dev/toolkits/callerapi) - CallerAPI is a white-label caller identification platform for branded caller ID and fraud prevention. It helps businesses boost customer trust while stopping spam, fraud, and robocalls.
- [Callingly](https://composio.dev/toolkits/callingly) - Callingly is a lead response management platform that automates immediate call and text follow-ups with new leads. It helps sales teams boost response speed and close more deals by connecting seamlessly with CRMs and lead sources.
- [Callpage](https://composio.dev/toolkits/callpage) - Callpage is a lead capture platform that lets businesses instantly connect with website visitors via callback. It boosts lead generation and increases your sales conversion rates.
- [Clearout](https://composio.dev/toolkits/clearout) - Clearout is an AI-powered service for verifying, finding, and enriching email addresses. It boosts deliverability and helps you discover high-quality leads effortlessly.
- [Clientary](https://composio.dev/toolkits/clientary) - Clientary is a platform for managing clients, invoices, projects, proposals, and more. It streamlines client work and saves you serious admin time.
- [Convolo ai](https://composio.dev/toolkits/convolo_ai) - Convolo ai is an AI-powered communications platform for sales teams. It accelerates lead response and improves conversion rates by automating calls and integrating workflows.
- [Delighted](https://composio.dev/toolkits/delighted) - Delighted is a customer feedback platform based on the Net Promoter System®. It helps you quickly gather, track, and act on customer sentiment.
- [Docsbot ai](https://composio.dev/toolkits/docsbot_ai) - Docsbot ai is a platform that lets you build custom AI chatbots trained on your documentation. It automates customer support and content generation, saving time and improving response quality.
- [Emelia](https://composio.dev/toolkits/emelia) - Emelia is an all-in-one B2B prospecting platform for cold-email, LinkedIn outreach, and prospect research. It streamlines outbound campaigns so you can find, engage, and warm up leads faster.
- [Findymail](https://composio.dev/toolkits/findymail) - Findymail is a B2B data provider offering verified email and phone contacts for sales prospecting. Enhance outreach with automated exports, email verification, and CRM enrichment.
- [Freshdesk](https://composio.dev/toolkits/freshdesk) - Freshdesk is customer support software with ticketing and automation tools. It helps teams streamline helpdesk operations for faster, better customer support.
- [Fullenrich](https://composio.dev/toolkits/fullenrich) - FullEnrich is a B2B contact enrichment platform that aggregates emails and phone numbers from 15+ data vendors. Instantly find and verify lead contact data to boost your outreach.
- [Gatherup](https://composio.dev/toolkits/gatherup) - GatherUp is a customer feedback and online review management platform. It helps businesses boost their reputation by streamlining how they collect and manage customer feedback.
- [Getprospect](https://composio.dev/toolkits/getprospect) - Getprospect is a business email discovery tool with LinkedIn integration. Use it to quickly find and verify professional email addresses.

## Frequently Asked Questions

### Do I need my own developer credentials to use Botstar with Composio?

Yes, Botstar requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)