NAiOS IconNAiOS Logo
Volver al catálogo

Botstar

botstar

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

Acciones
9
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (9)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

BotStar LiveChat onClose CallbackBOTSTAR_BOTSTAR_LIVECHAT_ON_CLOSEAcción

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

Parámetros de entrada

  • callback_codestringObligatorio

    JavaScript code to execute inside the onClose callback.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get BotStar Application IDsBOTSTAR_GET_BOT_APP_IDAcción

Tool to retrieve the botstar application id (`appid`). use when initializing or reinitializing the live chat widget.

Parámetros de entrada

  • bot_idinteger

    Internal BotStar ID of the bot. If provided, only returns the matching bot's appId.

  • bot_namestring

    Case-insensitive name of the bot to filter by. Ignored if `bot_id` is provided. If neither is provided, returns all bots.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Livechat bootBOTSTAR_LIVECHAT_BOOTAcción

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

Parámetros de entrada

  • modestringenum

    Display mode of the widget.

    livechatpopupinlinefullpage
  • userobject

    User data attributes to load or update. Unset fields will be ignored.

  • appIdstringObligatorio

    Your BotStar application ID.

  • blockstring

    ID of the starting block in your chatbot flow to display next.

  • variablesobject

    Map of custom variables (string keys) to string or number values.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Close BotStar Livechat WidgetBOTSTAR_LIVECHAT_CLOSEAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Livechat on openBOTSTAR_LIVECHAT_ON_OPENAcción

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

Parámetros de entrada

  • callbackstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Livechat openBOTSTAR_LIVECHAT_OPENAcción

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').

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Livechat updateBOTSTAR_LIVECHAT_UPDATEAcción

Tool to update user details on the current live chat session. use when you need to modify user profile attributes during an active conversation.

Parámetros de entrada

  • tagsstring[]

    Tags associated with the user. This will replace current tags.

  • emailstring

    User's email address.

  • avatarstring

    URL to the user's avatar image.

  • genderstringenum

    User's gender. Choose from 'male', 'female', or ''.

    malefemale
  • user_idstring

    Unique identifier for the user.

  • birthdaystring

    User's birthday in 'YYYY-MM-DD' format.

  • last_namestring

    User's last name.

  • first_namestring

    User's first name.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get BotStar Webview ParameterBOTSTAR_WEBVIEW_GET_PARAMETERAcción

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.

Parámetros de entrada

  • parameter_namestringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Webview send responseBOTSTAR_WEBVIEW_SEND_RESPONSEAcción

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.

Parámetros de entrada

  • outputsobjectObligatorio

    Object of outputs where each key corresponds to a bs:output:<key> meta tag, and values must be string or number.

  • responsestringObligatorio

    Anything you want to respond back to the BotStar chatbot.

  • outlet_namestringObligatorio

    Name of the outlet to send data through, requires a bs:outlet:<outletName> meta tag.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not