# Botstar

BotStar is a comprehensive chatbot platform that enables businesses to design, develop, and train chatbots visually for Messenger and websites.

- **Category:** ai chatbots
- **Auth:** API_KEY
- **Tools:** 31
- **Triggers:** 0
- **Slug:** `BOTSTAR`
- **Version:** 20260217_00

## Tools

### Create Bot

**Slug:** `BOTSTAR_CREATE_BOT`

Tool to create a new bot in BotStar. Use when you need to create a new bot instance with a specific name.

### Create Bot Attribute

**Slug:** `BOTSTAR_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.

### Create CMS Entity

**Slug:** `BOTSTAR_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.

### Create Entity Fields

**Slug:** `BOTSTAR_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.

### Create Entity Item

**Slug:** `BOTSTAR_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.

### Create User Attributes

**Slug:** `BOTSTAR_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.

### Delete Bot Attribute

**Slug:** `BOTSTAR_DELETE_BOT_ATTRIBUTE`

Tool to delete a bot attribute by ID. Use when you need to remove a custom attribute from a bot.

### Delete CMS Entity

**Slug:** `BOTSTAR_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.

### Delete Entity Fields

**Slug:** `BOTSTAR_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.

### Delete Entity Item

**Slug:** `BOTSTAR_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.

### Get Bot

**Slug:** `BOTSTAR_GET_BOT`

Tool to get your bot by bot ID. Use when you need detailed bot information including ID, name, and team name.

### Get BotStar Application IDs

**Slug:** `BOTSTAR_GET_BOT_APP_ID`

Tool to retrieve the BotStar application ID (`appId`). Use when initializing or reinitializing the live chat widget.

### Get CMS Entity

**Slug:** `BOTSTAR_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.

### Get Entity Item

**Slug:** `BOTSTAR_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.

### List Bot Attributes

**Slug:** `BOTSTAR_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.

### List Bots

**Slug:** `BOTSTAR_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.

### List CMS Entities

**Slug:** `BOTSTAR_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.

### List Entity Items

**Slug:** `BOTSTAR_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.

### Livechat boot

**Slug:** `BOTSTAR_LIVECHAT_BOOT`

Tool to reinitialize the live chat widget with provided data. Use after initial load to reset or update widget configuration.

### Close BotStar Livechat Widget

**Slug:** `BOTSTAR_LIVECHAT_CLOSE`

Tool to hide the live chat window. Use when the chat widget is configured in livechat or popup mode.

### BotStar LiveChat onClose Callback

**Slug:** `BOTSTAR_LIVECHAT_ON_CLOSE`

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."

### Livechat on open

**Slug:** `BOTSTAR_LIVECHAT_ON_OPEN`

Tool to register a callback when the chat window is opened. Use after widget initialization.

### Livechat open

**Slug:** `BOTSTAR_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').

### Livechat update

**Slug:** `BOTSTAR_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.

### Publish Bot to Live

**Slug:** `BOTSTAR_PUBLISH_BOT`

Tool to publish a bot to live. Use when you need to deploy changes to the production environment.

### Update Bot Attribute

**Slug:** `BOTSTAR_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.

### Update CMS Entity

**Slug:** `BOTSTAR_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.

### Update Entity Fields

**Slug:** `BOTSTAR_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.

### Update Entity Item

**Slug:** `BOTSTAR_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.

### Get BotStar Webview Parameter

**Slug:** `BOTSTAR_WEBVIEW_GET_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.

### Webview send response

**Slug:** `BOTSTAR_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.
