Tools

Botstar

Learn how to use Botstar with Composio

Overview

Enum

BOTSTAR

Description

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

Authentication Details

bearer_token
stringRequired

Actions

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

Action Parameters

callback_code
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve the botstar application id (`appid`). use when initializing or reinitializing the live chat widget.

Action Parameters

bot_id
integer
bot_name
string

Action Response

data
object
error
string
successful
boolean
Tool to reinitialize the live chat widget with provided data. use after initial load to reset or update widget configuration.

Action Parameters

appId
stringRequired
block
string
mode
string
user
object
variables
object

Action Response

data
object
error
string
successful
boolean
Tool to hide the live chat window. use when the chat widget is configured in livechat or popup mode.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to register a callback when the chat window is opened. use after widget initialization.

Action Parameters

callback
stringRequired

Action Response

data
object
error
string
successful
boolean
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').

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to update user details on the current live chat session. use when you need to modify user profile attributes during an active conversation.

Action Parameters

avatar
string
birthday
string
email
string
first_name
string
gender
string
last_name
string
tags
array
user_id
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

parameter_name
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

outlet_name
stringRequired
outputs
objectRequired
response
stringRequired

Action Response

data
object
error
string
successful
boolean