# 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
- **Composio Managed App Available?** N/A
- **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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the bot to create. Maximum 250 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment scope for the attribute. |
| `desc` | string | No | Description of the attribute |
| `name` | string | Yes | Attribute name (max 250 characters) |
| `botId` | string | Yes | Your bot ID |
| `value` | string | No | Initial value for the attribute. For date type, use date format (YYYY-MM-DD). For string/number types, use string representation |
| `data_type` | string ("date" | "string" | "number") | Yes | Data type for the attribute. Choose from: date, string, or number |
| `additional_values` | object | No | Multilingual values for the attribute. Use keys like 'value_es', 'value_fr', etc. to provide translations |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment types for CMS entities. |
| `name` | string | Yes | Name of the CMS entity to create |
| `bot_id` | string | Yes | Your bot ID (typically a UUID format string) |
| `fields` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment where fields will be created. Use 'draft' for draft environment only, or 'draft,live' for both. |
| `botId` | string | Yes | Your bot ID. Must be a valid BotStar bot identifier. |
| `fields` | array | Yes | Array of field definitions to create. Each field must have data_type, name, and unique_name. |
| `entityId` | string | Yes | Entity ID where fields will be created. Must be a valid CMS entity identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment options for entity operations. |
| `name` | string | Yes | Name of the entity item. This is a required field that identifies the item. |
| `bot_id` | string | Yes | Your bot ID. This is the unique identifier for the bot where the entity exists. |
| `status` | string ("enabled" | "disabled") | No | Status values for entity items. |
| `entity_id` | string | Yes | Entity ID. This is the unique identifier for the CMS entity where the item will be created. |
| `additional_fields` | object | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment options for bot attribute deletion. |
| `bot_id` | string | Yes | Your bot ID (UUID format) |
| `attribute_id` | string | Yes | Bot Attribute ID to delete (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment type for CMS entity deletion. |
| `bot_id` | string | Yes | Your bot ID |
| `entity_id` | string | Yes | Entity ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment options for entity field deletion. |
| `botId` | string | Yes | Your bot ID |
| `entityId` | string | Yes | Entity ID |
| `unique_names` | string | No | The list of Entity field unique_names, comma-separated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment type for entity item deletion. |
| `bot_id` | string | Yes | Your bot ID. This identifies the bot containing the CMS entity. |
| `entity_id` | string | Yes | Entity ID. This identifies the CMS entity containing the item to delete. |
| `entity_item_id` | string | Yes | Entity Item ID. This identifies the specific item to delete from the CMS entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Your bot ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | integer | No | Internal BotStar ID of the bot. If provided, only returns the matching bot's appId. |
| `bot_name` | string | No | Case-insensitive name of the bot to filter by. Ignored if `bot_id` is provided. If neither is provided, returns all bots. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "live") | No | Environment for CMS entity retrieval. |
| `bot_id` | string | Yes | Your bot ID |
| `entity_id` | string | Yes | Entity ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "live") | No | Environment setting for entity data. |
| `bot_id` | string | Yes | Your bot ID. |
| `entity_id` | string | Yes | Entity ID. |
| `entity_item_id` | string | Yes | Entity Item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "live") | No | Environment options for bot attribute retrieval. |
| `bot_id` | string | Yes | Your bot ID (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "live") | No | Environment type for CMS entities. |
| `botId` | string | Yes | Your bot ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "live") | No | Environment for entity items. |
| `name` | string | No | Filter entity items by name (exact match) |
| `page` | integer | No | Page number for pagination (starts at 1) |
| `limit` | integer | No | Number of items to return per page (max 1000) |
| `bot_id` | string | Yes | Your bot ID (UUID format) |
| `status` | string ("enabled" | "disabled") | No | Status of entity items. |
| `entity_id` | string | Yes | Entity ID (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback_code` | string | Yes | JavaScript code to execute inside the onClose callback. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Livechat on open

**Slug:** `BOTSTAR_LIVECHAT_ON_OPEN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback` | string | Yes | JavaScript callback function to execute when the chat window opens (e.g., `function() { /* ... */ }`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags associated with the user. This will replace current tags. |
| `email` | string | No | User's email address. |
| `avatar` | string | No | URL to the user's avatar image. |
| `gender` | string ("male" | "female" | "") | No | User's gender. Choose from 'male', 'female', or ''. |
| `user_id` | string | No | Unique identifier for the user. |
| `birthday` | string | No | User's birthday in 'YYYY-MM-DD' format. |
| `last_name` | string | No | User's last name. |
| `first_name` | string | No | User's first name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Your bot ID to publish to production environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment options for bot attribute updates. |
| `desc` | string | No | Updated description for the bot attribute. |
| `value` | string | No | Updated value for the bot attribute. Can be a string, number, or float. |
| `bot_id` | string | Yes | Your bot ID (UUID format). |
| `attribute_id` | string | Yes | Bot Attribute ID (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment type for CMS entity update. |
| `name` | string | Yes | New name for the CMS entity. |
| `bot_id` | string | Yes | Your bot ID. This identifies which bot the CMS entity belongs to. |
| `entity_id` | string | Yes | Entity ID. This uniquely identifies the CMS entity to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string | No | Environment to update fields in. Use 'draft' for draft environment or 'draft,live' for both. |
| `bot_id` | string | Yes | Your bot ID (UUID format). Find this using the Get Bot App ID action. |
| `fields` | array | Yes | List of field updates to apply. Each field must specify unique_name and optionally name and/or options. |
| `entity_id` | string | Yes | Entity ID (UUID format) to update fields for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `env` | string ("draft" | "draft,live") | No | Environment to update the entity item in. Choose 'draft' for draft only, or 'draft,live' for both draft and live environments. |
| `name` | string | No | Updated name for the entity item |
| `bot_id` | string | Yes | Your bot ID |
| `status` | string ("enabled" | "disabled") | No | Status of an entity item. |
| `entity_id` | string | Yes | Entity ID |
| `custom_fields` | object | No | 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. |
| `entity_item_id` | string | Yes | Entity Item ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parameter_name` | string | Yes | Name of the parameter as defined in your HTML meta tag `bs:input:<dataName>` |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputs` | object | Yes | Object of outputs where each key corresponds to a bs:output:<key> meta tag, and values must be string or number. |
| `response` | string | Yes | Anything you want to respond back to the BotStar chatbot. |
| `outlet_name` | string | Yes | Name of the outlet to send data through, requires a bs:outlet:<outletName> meta tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |