Skip to main content
Botstar logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 31
  • Triggers: 0
  • Slug: BOTSTAR
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
Name of the bot to create. Maximum 250 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_CREATE_BOT_ATTRIBUTETool 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.

Input Parameters

string ("draft" | "draft,live")
Environment scope for the attribute.
string
Description of the attribute
string
required
Attribute name (max 250 characters)
string
Initial value for the attribute. For date type, use date format (YYYY-MM-DD). For string/number types, use string representation
string
required
Your bot ID
string ("date" | "string" | "number")
required
Data type for the attribute. Choose from: date, string, or number
object
Multilingual values for the attribute. Use keys like ‘value_es’, ‘value_fr’, etc. to provide translations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_CREATE_CMS_ENTITYTool 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.

Input Parameters

string ("draft" | "draft,live")
Environment types for CMS entities.
string
required
Name of the CMS entity to create
string
required
Your bot ID (typically a UUID format string)
array
Optional array of field definitions for the entity. Each field has a data_type, name, unique_name, and optional options (for single_option/multiple_options types).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_CREATE_ENTITY_FIELDSTool 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.

Input Parameters

string ("draft" | "draft,live")
Environment where fields will be created. Use ‘draft’ for draft environment only, or ‘draft,live’ for both.
string
required
Your bot ID. Must be a valid BotStar bot identifier.
array
required
Array of field definitions to create. Each field must have data_type, name, and unique_name.
string
required
Entity ID where fields will be created. Must be a valid CMS entity identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_CREATE_ENTITY_ITEMTool to create a new entity item in BotStar CMS. Use when adding items to a CMS entity with custom field values.

Input Parameters

string ("draft" | "draft,live")
Environment options for entity operations.
string
required
Name of the entity item. This is a required field that identifies the item.
string
required
Your bot ID. This is the unique identifier for the bot where the entity exists.
string ("enabled" | "disabled")
Status values for entity items.
string
required
Entity ID. This is the unique identifier for the CMS entity where the item will be created.
object
Additional custom fields for the entity item. The keys should match the unique field names defined in your CMS entity schema. Values can be strings or arrays of strings depending on your entity field definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_CREATE_USER_ATTRIBUTESTool to create custom user attributes in BotStar. Use when you need to define new custom attributes for users with specified field name and type.

Input Parameters

string
required
Your bot ID (UUID format). This is the unique identifier for your BotStar bot.
string
required
Name of the custom attribute field to create. Must be at least 1 character long.
string ("string" | "number" | "date" | "boolean")
required
Type of the custom attribute field. Choose from: string, number, date, or boolean.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_DELETE_BOT_ATTRIBUTETool to delete a bot attribute by ID. Use when you need to remove a custom attribute from a bot.

Input Parameters

string ("draft" | "draft,live")
Environment options for bot attribute deletion.
string
required
Your bot ID (UUID format)
string
required
Bot Attribute ID to delete (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_DELETE_CMS_ENTITYTool to delete a CMS entity by ID. Use when you need to remove an entity from the bot’s content management system.

Input Parameters

string ("draft" | "draft,live")
Environment type for CMS entity deletion.
string
required
Your bot ID
string
required
Entity ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_DELETE_ENTITY_FIELDSTool to delete entity field(s) from a CMS entity. Use when you need to remove fields from a CMS entity by their unique names.

Input Parameters

string ("draft" | "draft,live")
Environment options for entity field deletion.
string
required
Your bot ID
string
required
Entity ID
string
The list of Entity field unique_names, comma-separated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_DELETE_ENTITY_ITEMTool to delete an entity item from a CMS entity. Use when you need to remove a specific item from a bot’s CMS entity.

Input Parameters

string ("draft" | "draft,live")
Environment type for entity item deletion.
string
required
Your bot ID. This identifies the bot containing the CMS entity.
string
required
Entity ID. This identifies the CMS entity containing the item to delete.
string
required
Entity Item ID. This identifies the specific item to delete from the CMS entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_GET_BOTTool to get your bot by bot ID. Use when you need detailed bot information including ID, name, and team name.

Input Parameters

string
required
Your bot ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_GET_BOT_APP_IDTool to retrieve the BotStar application ID (appId). Use when initializing or reinitializing the live chat widget.

Input Parameters

integer
Internal BotStar ID of the bot. If provided, only returns the matching bot’s appId.
string
Case-insensitive name of the bot to filter by. Ignored if bot_id is provided. If neither is provided, returns all bots.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_GET_CMS_ENTITYTool 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.

Input Parameters

string ("draft" | "live")
Environment for CMS entity retrieval.
string
required
Your bot ID
string
required
Entity ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_GET_ENTITY_ITEMTool 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.

Input Parameters

string ("draft" | "live")
Environment setting for entity data.
string
required
Your bot ID.
string
required
Entity ID.
string
required
Entity Item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIST_BOT_ATTRIBUTESTool 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.

Input Parameters

string ("draft" | "live")
Environment options for bot attribute retrieval.
string
required
Your bot ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIST_BOTSList bots associated with your account, with optional page and limit controls. Returns a list of bots with their ID, name, and team name.

Input Parameters

integer
Page number for pagination (starts at 1)
integer
Maximum number of bots to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIST_CMS_ENTITIESTool to retrieve all CMS entities for a bot. Use when you need to access entity definitions, field configurations, or available entity schemas.

Input Parameters

string ("draft" | "live")
Environment type for CMS entities.
string
required
Your bot ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIST_ENTITY_ITEMSList a page of CMS entity items, with optional filtering by name and status. The response indicates whether there may be more pages.

Input Parameters

string ("draft" | "live")
Environment for entity items.
string
Filter entity items by name (exact match)
integer
Page number for pagination (starts at 1)
integer
Number of items to return per page (max 1000)
string
required
Your bot ID (UUID format)
string ("enabled" | "disabled")
Status of entity items.
string
required
Entity ID (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_BOOTGenerate a JavaScript snippet to reinitialize the live chat widget with provided data after its initial load.

Input Parameters

string ("livechat" | "popup" | "inline" | "fullpage")
Display mode of the widget.
object
User data attributes to load or update. Unset fields will be ignored.
string
required
Your BotStar application ID.
string
ID of the starting block in your chatbot flow to display next.
object
Map of custom variables (string keys) to string or number values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_CLOSEGenerate a JavaScript snippet to hide the live chat window when the widget is configured in livechat or popup mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_ON_CLOSEGenerate a JavaScript snippet to register a callback for when the live chat window closes. Use it after the widget is initialized.

Input Parameters

string
required
JavaScript code to execute inside the onClose callback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_ON_OPENGenerate a JavaScript snippet to register a callback for when the live chat window opens. Use it after widget initialization.

Input Parameters

string
required
JavaScript callback function to execute when the chat window opens (e.g., function() { /* ... */ }).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_OPENGenerate a JavaScript snippet to show the live chat window after the widget has been bootstrapped. The widget must be in livechat or popup mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_LIVECHAT_UPDATEGenerate a JavaScript snippet to update user details on the current live chat session. Supplied tags replace the user’s current tags.

Input Parameters

array
Tags associated with the user. This will replace current tags.
string
User’s email address.
string
URL to the user’s avatar image.
string ("male" | "female" | "")
User’s gender. Choose from ‘male’, ‘female’, or ”.
string
Unique identifier for the user.
string
User’s birthday in ‘YYYY-MM-DD’ format.
string
User’s last name.
string
User’s first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_PUBLISH_BOTTool to publish a bot to live. Use when you need to deploy changes to the production environment.

Input Parameters

string
required
Your bot ID to publish to production environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_UPDATE_BOT_ATTRIBUTETool 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.

Input Parameters

string ("draft" | "draft,live")
Environment options for bot attribute updates.
string
Updated description for the bot attribute.
string
Updated value for the bot attribute. Can be a string, number, or float.
string
required
Your bot ID (UUID format).
string
required
Bot Attribute ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_UPDATE_CMS_ENTITYUpdate the name of an existing BotStar CMS entity.

Input Parameters

string ("draft" | "draft,live")
Environment type for CMS entity update.
string
required
New name for the CMS entity.
string
required
Your bot ID. This identifies which bot the CMS entity belongs to.
string
required
Entity ID. This uniquely identifies the CMS entity to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_UPDATE_ENTITY_FIELDSTool to update entity field(s) in BotStar CMS. Use when you need to modify the name or options of existing fields.

Input Parameters

string
Environment to update fields in. Use ‘draft’ for draft environment or ‘draft,live’ for both.
string
required
Your bot ID (UUID format). Find this using the Get Bot App ID action.
array
required
List of field updates to apply. Each field must specify unique_name and optionally name and/or options.
string
required
Entity ID (UUID format) to update fields for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_UPDATE_ENTITY_ITEMTool 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.

Input Parameters

string ("draft" | "draft,live")
Environment to update the entity item in. Choose ‘draft’ for draft only, or ‘draft,live’ for both draft and live environments.
string
Updated name for the entity item
string
required
Your bot ID
string ("enabled" | "disabled")
Status of an entity item.
string
required
Entity ID
object
Custom field values for the entity item. Keys are the unique field names. Values can be strings or arrays of strings depending on the field type.
string
required
Entity Item ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_WEBVIEW_GET_PARAMETERGenerate a JavaScript snippet to retrieve a parameter passed from the BotStar chatbot to the webview. Use it inside onChatBotReady after the page loads in modal mode with bs:input meta tags.

Input Parameters

string
required
Name of the parameter as defined in your HTML meta tag bs:input:<dataName>

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSTAR_WEBVIEW_SEND_RESPONSEGenerate a JavaScript snippet to send a response and custom outputs from a webview back to the BotStar chatbot.

Input Parameters

object
required
Object of outputs where each key corresponds to a bs:output:<key> meta tag, and values must be string or number.
string
required
Anything you want to respond back to the BotStar chatbot.
string
required
Name of the outlet to send data through, requires a bs:outlet:<outletName> meta tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not