Input: {"body":{"maxTokens":2000,"messages":[{"content":"You are summarizing a text. The text is split into 1 parts, and you are currently working on part 1.\nAt every step, you will receive the current summary and a new part of the text. You need to amend the summary to include the new information (if needed).\nThe summary needs to cover the main points of the text and must be concise.\n\nIMPORTANT INSTRUCTIONS:\n- At each step, you will receive a part of the text to summarize. Make sure to reply with the new summary in the tags ■START■ and ■END■.\n- Summarize the text and make sure that the main points are included.\n- Ignore any unnecessary details and focus on the main points.\n- Use short and concise sentences to increase readability and information density.\n- When looking at the new information, focus on: Extract the Table of Contents for the Botpress Documentation. Pay special attention to all the different features. Focus on horizontal coverage of features rather than going in depth into one feature. The goal is to have a complete overview of what the documentation covers.\n- The current summary is empty. You need to generate a summary that covers the main points of the text.\n- This is the last part you will have to summarize. Make sure the summary is complete and covers all the main points.\n- The current summary is 0 tokens long. You need to make sure it is 2000 tokens or less.\n\nFORMAT OF THE SUMMARY:\nA normal text with multiple sentences and paragraphs. Use markdown to format the text into sections. Use headings, lists, and other markdown features to make the text more readable. Do not include links, images, or other non-text elements.","role":"system"},{"content":"■START■\n<summary still empty>\n■END■\n\nPlease amend the summary between the ■START■ and ■END■ tags to accurately reflect the prompt and the additional text below.\n\n<|start_new_information|>\nhttps://sso.botpress.cloud) and a [Botpress Bot](https://botpress.com/docs/cloud/getting-started/create-and-publish-your-chatbot/)\n* Make sure you've [published your Botpress bot](../docs/create-publish-your-chatbot#publishing-your-bot).\nSetting up the Webchat integration in Botpress\n[](#setting-up-the-webchat-integration-in-botpress)\n1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).\n2. Find and open the Webchat integration then click on the \"Install to Bot\" button, now go back to your bot.\nSetting up the Webchat\n[](#setting-up-the-webchat)\nPre-configured Script\n[](#pre-configured-script)\n**Shareable URL**\nYou can share your chatbot with people that would like to quickly test your chatbot using the **Shareable Link**.\n**Embedded Script**\nThis script will add the webchat to your website. You can copy the script and paste it in the `<body></body>` tag of your HTML page.\nThis is the **recommended** way of adding the webchat to your website.\nConfigurable Script\n[](#configurable-script)\nThe configurable webchat code must be updated manually every time there is a change. We highly recommend using the **Pre-configured** version.\nCopy the code from the **Configurable** tab and paste it in the `<body></body>` tag of your HTML page.\nConfigurable Script Parameters\n[](#configurable-script-parameters)\nYou can customize the webchat by changing/adding the values of the parameters in the script.\n| **Parameter**              | **Description**                                                                                | **Default value**    | **parameter type** |\n| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------ |\n| stylesheet                 | Provide a path to a stylesheet to customize the webchat                                                                                | \\-                   | string             |\n| showConversationsButton    | If false, will hide the conversation list pane                                                                                | true                 | boolean            |\n| showTimestamp              | If true, will display a timestamp under each messages                                                                                | false                | boolean            |\n| enableTranscriptDownload   | Allows the user to download the conversation history                                                                                | true                 | boolean            |\n| enableConversationDeletion | Allows the user to delete its conversation history                                                                                | false                | boolean            |\n| closeOnEscape              | Close the webchat when pressing the Esc key                                                                                | true                 | boolean            |\n| botName                    | Displays the bot name to the right of its avatar                                                                                | \\-                   | string             |\n| composerPlaceholder        | Allows to set a custom composer placeholder                                                                                | 'Reply to {botname}' | string             |\n| avatarUrl                  | Allow to specify a custom URL for the bot's avatar                                                                                | \\-                   | string             |\n| locale                     | Force the display language of the webchat (en, fr, ar, ru, etc..)  Defaults to the user's browser language if not set Set to 'browser' to force use the browser's language | 'browser'            | string             |\n| botConversationDescription | Small description written under the bot's name                                                                                | \\-                   | string             |\n| hideWidget                 | When true, the widget button to open the chat is hidden                                                                                | false                | boolean            |\n| disableAnimations          | Disable the slide in / out animations of the webchat                                                                                | false                | boolean            |\n| useSessionStorage          | Use sessionStorage instead of localStorage, which means the session expires when tab is closed                                                                             | false                | boolean            |\n| containerWidth             | Sends an event to the parent container with the width provided                                                                                | 360                  | string OR number   |\n| layoutWidth                | Sets the width of the webchat                                                                                | 360                  | string OR number   |\n| enablePersistHistory       | When enabled, sent messages are persisted to local storage (recall previous messages)                                                                                | true                 | boolean            |\n| className                  | CSS class to be applied to iframe                                                                                | \\-                   | string             |\n| disableNotificationSound   | If true, chat will no longer play the notification sound for new messages.                                                                                | false                | boolean            |\n| googleMapsAPIKey           | Google Maps API Key required to display the map. It will display a link to Google Maps otherwise.                                                                          | \\-                   | string             |\n| website                    | Displays the bot's website in the conversation page                                                                                | \\-                   | string             |\n| phoneNumber                | Displays the bot's contact phone number in the conversation page                                                                                | \\-                   | string             |\n| termsConditions            | Displays the bot's terms of service in the conversation page                                                                                | \\-                   | string             |\n| privacyPolicy              | Displays the bot's privacy policy in the conversation page                                                                                | \\-                   | string             |\n| emailAddress               | Displays the bot's email address in the conversation page.                                                                                | \\-                   | string             |\n| coverPictureUrl            | Displays the bot's cover picture in the conversation page                                                                                | \\-                   | string             |\n| showBotInfoPage            | Enables the bot's information page in the webchat                                                                                | false                | boolean            |\n| showCloseButton            | Display's the webchat close button when the webchat is opened                                                                                | true                 | boolean            |\n| userData                   | Passes the user data to the bot                                                                                | \\-                   | object             |\n| customUser                 | Passes the custom user data to the bot                                                                                | \\-                   | object             |\nDomain Whitelisting\n[](#domain-whitelisting)\n> ## ��\n>\n> Team Plan\n>\n> This feature is only available to Team plan subscribers.\nThe domain whitelisting feature ensures that only approved domains can host and utilize the chatbot. This enhances security and control, ensuring that your chatbot is only available on trusted websites.\nConfiguring Allowed Origins\n[](#configuring-allowed-origins)\n1. Navigate to the Webchat integration settings on your Dashboard\n2. Expand the 'Advanced Settings' menu\n3. To add a domain (or an allowed origin), type the domain name in the provided field. You can provide multiple allowed origins or whitelisted domains.\nMake sure to save the configuration after you've indicated which domains you want to whitelist.\nCustomizing/Controlling the Webchat\n[](#customizingcontrolling-the-webchat)\nFor more information on customizing the webchat, please refer to the [Webchat developer documentation](../docs/controlling-web-chat-using-javascript).\nUpdated 3 months ago\n---\n* [Table of Contents](#)\n* * [Prerequisites](#prerequisites)  \n   * [Setting up the Webchat integration in Botpress](#setting-up-the-webchat-integration-in-botpress)  \n   * [Setting up the Webchat](#setting-up-the-webchat)  \n         * [Pre-configured Script](#pre-configured-script)  \n         * [Configurable Script](#configurable-script)  \n         * [Configurable Script Parameters](#configurable-script-parameters)  \n         * [Domain Whitelisting](#domain-whitelisting)  \n         * [Customizing/Controlling the Webchat](#customizingcontrolling-the-webchat)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nUsage\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Usage\nSee your monthly Workspace limits.\n[ Suggest Edits](/edit/usage-2)\nThe Usage tab provides a view of the computational resources used by all of the bots in your Workspace. Having this information is useful to understand the performance of each chatbot in your Workspace and to plan for future growth. The resources are grouped by the following categories:\nAI Spend\n[](#ai-spend)\nThe AI Spend resource shows the amount that service providers charge for the consumption of tokens used to perform actions powered by AI models like generate text and retrieve answers from knowledge bases. AI Spend cost is charged at cost, meaning you pay for the exact amount of tokens used by your bot without any additional markup. You can find additional information about the token consumption of each action taken by your bot in the logs available through the emulator.\nAI Spend includes a free monthly credit of 5 USD per month. You can increase this limit by following these steps:\n1. Navigate to your Dashboard\n2. Navigate to the Usage tab\n3. Click on 'Manage spending limit'\n4. Change the amount of your 'AI Spend Limit'. You will be prompted to input a credit card.\nAI Spend is capped at 100 USD per month. If you plan to exceed 100 USD of AI Spend in a given calendar month, please [contact us](https://botpress.com/contact-us) to increase this limit. You can estimate your AI Spend using our [AI Spend Calculator](https://botpress.com/ai-spend-calculator).\nFile Storage\n[](#file-storage)\nThe File Storage section shows the amount of storage in Megabytes (MB) used across your Workspace, as well as the maximum storage limit. Files included in this storage include photos, videos, and audio files that you've uploaded to be sent by your chatbot.\nTable Rows\n[](#table-rows)\nThe Table Row section shows the number of rows in the bot's tables and the limit. It accounts for total the number of rows in all of your [chatbot Tables](https://botpress.com/docs/cloud/studio/tables).\nVector DB Storage\n[](#vector-db-storage)\nThe Vector Database Storage section shows the maximum storage available for Knowledge Base documents. It accounts for the total number of vectors (condensed pieces of your content) in all of your [Knowledgebase](https://botpress.com/docs/cloud/studio/knowledge-base) documents as well as searchable columns in your tables.\nThis value is expressed in MB for convenience, but the actual billing unit is a measure of vectorized storage, used for performing RAG (Retrieval Augmented Generation) functions on your Knowledge Base(s).\nIncoming Messages & Events\n[](#incoming-messages--events)\nThe Incoming Messages & Events section shows the number of times the chatbot has been invoked in any channel and the maximum amount of times it can be invoked before it will stop responding. It counts new conversations, conversations resumed after a [Timeout](https://botpress.com/docs/cloud/studio/chatbot-settings/#inactivity-timeout-minutes), and conversations started by [Triggers](https://botpress.com/docs/cloud/toolbox/events-triggers).\nCollaborators\n[](#collaborators)\nCollaborators indicates the maximum amount of users that can collaborate in this Workspace. Adding or removing collaborators will increase or decrease this number in real time.\nBot Count\n[](#bot-count)\nBot Count indicates the maximum number of bots this Workspace can hold. Once you reach the maximum number of bots, you can purchase additional slots, or delete any unused bots to make room for new ones.\nAlways Alive\n[](#always-alive)\nThe Always Alive usage limit indicates how many remaining bots you can allocate the Always Alive status to.\nWhat is Always Alive?\n[](#what-is-always-alive)\nBotpress bots are powered by remote, virtual compute instances. Every time your bot begins a conversation, for example when a Trigger is activated or a new user sends a message, Botpress spins up a new instance for that bot. This is known as a 'cold start', which refers to the initial startup process when a virtual machine (VM) or a serverless function is launched for the first time, or after it has been idle and terminated. During a cold start, the system must allocate resources, initialize the environment, load necessary code, and perform any required configuration before the instance is ready to handle requests or tasks.\nAlways Alive reserves an instance for your bot so that it can bypass this cold start and maintains a ready-to-use instance. The end result is that the first message sent and received from your bot are processed much faster.\nAlways Alive can be purchased and allocated on a per-bot basis.\nUpdated about 1 month ago\n---\n* [Table of Contents](#)\n* * [AI Spend](#ai-spend)  \n   * [File Storage](#file-storage)  \n   * [Table Rows](#table-rows)  \n   * [Vector DB Storage](#vector-db-storage)  \n   * [Incoming Messages & Events](#incoming-messages--events)  \n   * [Collaborators](#collaborators)  \n   * [Bot Count](#bot-count)  \n   * [Always Alive](#always-alive)  \n         * [What is Always Alive?](#what-is-always-alive)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nWebchat v1 (deprecated)\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Webchat v1 (deprecated)\n[ Suggest Edits](/edit/web-chat-v1old)\nWebchat v1 is still available for use on your bots but will not be receiving updates as we transition to webchat v2 for all bots.\nUpdated about 1 month ago\n---[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nProfile Setting\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Profile Setting\n[ Suggest Edits](/edit/user-profile)\nUpdate Profile\n[](#update-profile)\n1. Click on the profile icon in the top right corner of your botpress dashboard and click on the `Update Profile` button.\n2. To change the profile image, click on the `Upload Image` button and select the image you want to upload.\n3. To change the profile name, enter the new name in the `Full Name` field.\n4. Click on the `Confirm` button to save the changes.\nLink/Unlink Social Accounts\n[](#linkunlink-social-accounts)\n1. Click on the profile icon in the top right corner of your botpress dashboard and click on the `Link Social Accounts` button.\n2. Click on the social media platform you want to link/unlink. (Github, Google, Microsoft, LinkedIn)\n3. Enter the credentials for the social media platform.\nChange Profile Password\n[](#change-profile-password)\n1. Click on the profile icon in the top right corner of your botpress dashboard and click on the `Change Password` button.\n2. Enter the new password in the `Password` field.\n3. Re-enter the new password in the `Confirm Password` field.\n4. Click on the `Confirm` button.\nPersonal Access Tokens\n[](#personal-access-tokens)\n1. Click on the profile icon in the top right corner of your botpress dashboard and click on the `Personal Access Tokens` button.\n2. Click on the `Generate New Token` button.\n3. Enter the note for the token (Optional) and click on the `Generate Token` button.\n4. Copy the token and store it in a safe place.\nUpdated about 1 month ago\n---\n* [Table of Contents](#)\n* * [Update Profile](#update-profile)  \n   * [Link/Unlink Social Accounts](#linkunlink-social-accounts)  \n   * [Change Profile Password](#change-profile-password)  \n   * [Personal Access Tokens](#personal-access-tokens)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nVersions\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Versions\nView, compare, and revert to previous versions of your bot.\n[ Suggest Edits](/edit/versions-1)\nVersions in Botpress help you track, manage, and control changes made to your bots.\nThey provide a detailed log of updates, allowing you to view past versions, compare changes, and revert to previous states if necessary. This feature is essential for collaborative bot development, ensuring transparency, accountability, and easy recovery from unintended changes.\nAccessing Versions\n[](#accessing-versions)\nThe Versions menu can be found on the left-hand menu by clicking on the icon that looks like a clock.\nCreating a new Version\n[](#creating-a-new-version)\nVersions are created in two ways:\n1. By clicking on the '+' in the Versions menu and manually creating a new Version\n2. Automatically, every time you publish your bot\nIt's a good idea to annotate every saved Version you have and indicate any of the major changes or updates made.\nReverting to a previous Version\n[](#reverting-to-a-previous-version)\nFrom the Versions menu, you can revert to a previous version by clicking into it and restoring to a previous Version. Note that reverting to a previous version will completely overwrite your current bot, including any unsaved changes you may have made.\nBotpress cannot restore lost or overwritten bot Versions.\n> ## ���\n>\n> Note\n>\n> Pay-as-you-go users have access to 3 saved Versions.\n>\n> Team Plan subscribers have access to 15 saved Versions.\nUpdated about 1 month ago\n---\n* [Table of Contents](#)\n* * [Accessing Versions](#accessing-versions)  \n   * [Creating a new Version](#creating-a-new-version)  \n   * [Reverting to a previous Version](#reverting-to-a-previous-version)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nVariables\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Variables\n[ Suggest Edits](/edit/variables)\nBotpress uses variables to store information from one place and use it in other parts of a flow. Variables help make conversations more personalized and help track information about users. They can also help connect with third-party APIs and data sources.\nVariable Scopes\n[](#variable-scopes)\nBotpress also includes different types of variables. These Variable types differ in scope or where they can be accessed in your bot's flows.\nCreating Variables in Botpress\n[](#creating-variables-in-botpress)\n1. Open up the Variables tab from the sidebar and click the **+** icon in the Variables section.\n2. A new window will appear, allowing you to formulate a new Variable.\n3. Assign a suitable scope (Workflow, Bot or User) to your Variable, select the Data Type (see below table), give it a name, and click **Add** to create the Variable.\n4. (Optional) From the Additional Settings, you can also initialize your Variable with a default value.\nUsing Variables in Botpress\n[](#using-variables-in-botpress)\nOnce the Variable is established, employ `{{workflow.variablename}}` or `@workflow.variablename` to render it in a send message card.\nData Types for Variables\n[](#data-types-for-variables)\nBotpress variables are typed, meaning they are limited in what data they can hold. Not only are these data types important to ensure the code behind Botpress runs smoothly, but these types also help AI tasks generate better results. Here are the different data types available for Botpress variables:\n| Type    | Description                                                                                |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| String  | Values that are treated as text. Strings can contain any amount of letters, numbers, or special characters.  Example uses: Storing a user's name, storing an AI task's generated message.                                                                       |\n| Boolean | Variables can be true or false, with a lowercase 't' or 'f'. Example uses: Storing if a user is a returning customer, storing whether the bot has greeted the user or not                                                                                |\n| Number  | Variables that are numeric, either with or without decimal places. Example uses: Storing a user's phone number, storing an address's area code                                                                                |\n| Date    | Variables that are a single date or date and time. Botpress uses ISO 8601 date/time format, such as 20220921T10:34:14 for 21 September 2023 at 10:34 AM (with 14 seconds). Example uses: Storing when the user starts a chat, storing a user's appointment date |\n| Object  | Variable that is a collection of key-value pairs. Useful when dealing with code and written like {key: value}. Example uses: Storing a user's profile, storing the results of an API call                                                                       |\n| Array   | Variable that is a collection of other, similar variables. Arrays can contain strings, like \\[“a”, “b”, “c”\\], or Objects like \\[{key:value},{key:value}\\]. Example uses: Storing a user's past messages, storing options for the user to choose from           |\n| Enum    | Variable that can be one of a set number of choices. Example uses: Storing days of the week, storing items available from a food menu                                                                                |\n| Pattern | Variable that uses Regular Expressions/Regex to store a special pattern. This pattern can match certain words or numbers. Example uses: Storing account numbers, storing flight numbers                                                                         |\nWorkflow Variables\n[](#workflow-variables)\nWorkflow Variables are created and used only within a single workflow. These variables are great for single-use or in standalone flows, such as:\n1. Storing an AI Task's output\n2. Saving the user's answer to a question\n3. Organizing data returned from an API call\n4. Saving flags or tags that track the conversation\n> ## ���\n>\n> Info\n>\n> Workflow variables are not accessible in any workflow other than the one they were created in. For example, a workflow Variable created in a separate workflow will not be accessible in **Main**.\nCreating a Workflow Variable\n[](#creating-a-workflow-variable)\nTo create a Variable in your bot's workflow, you can follow these steps:\n1. Select the appropriate workflow from the Flows section in the Side Panel.\n2. Click on the **+** icon in the Variables section, at the bottom of the Side Panel.\n3. Give your Variable a name, pick a type and click **Add** to create the Variable. (Default scope is Workflow)\n4. Once the Variable is created, you can use `{{workflow.variablename}}` or `@workflow.variablename` to display it in a send message card.\nInput and Output Workflow Variables\n[](#input-and-output-workflow-variables)\nWorkflows can have inputs and outputs to help pass information throughout the bot. This can be useful if your workflow returns information like a verified phone number, or requires information like a user id.\nTo mark an Input Variable\n[](#to-mark-an-input-variable)\n1. Go into your new workflow(not Main) and create a Variable and Click it's **Entry** node.\n2. In the inspector panel, click on the Variable you want to make an input. It should get a blue border and appear in the **Entry** node.\n3. When you call this workflow from another flow, there should be an input box for that Variable in the workflow's card. This will let you pass information or another Variable into that workflow.\nTo mark an Output Variable\n[](#to-mark-an-output-variable)\n1. Go into your new workflow(not Main) and create a Variable and click on the **Exit** node.\n2. In the inspector panel, click on the Variable you want to make an output. It should get a blue border and appear in the **Exit** node.\n3. When you call this workflow from another flow, the output Variable will be accessible by typing `{{workflow.<workflow-cardName>.<variablename>}}`, replacing `<workflow-cardName>` and `<variablename>` with the name of the card that represents your workflow and Variable respectively.\nUser Variables\n[](#user-variables)\nUser Variables are variables that follow a user between conversations. For example, if a user speaks with your bot on Monday and Wednesday, any user variables set on Monday will still be accessible on Wednesday. User variables are great for storing data that doesn't change very often, such as:\nStoring users' personal details or id numbers\n1. Collecting tags or notes from past conversations\n2. Storing extra flags like **VIP customer**\n3. Saving language preferences\nCreating a User Variable\n[](#creating-a-user-variable)\n1. Open up the Variables tab and navigate to the **+** icon in the Variables section.\n2. Change the scope to **User**, select the Data Type, give it a name, and click **Add** to create the Variable.\nUsing User Variables\n[](#using-user-variables)\nOnce the User Variable is established, employ `{{user.variablename}}` or `@user.variablename` to render it in a send message card.\nBot Variables\n[](#bot-variables)\nBot Variables can be accessed by all users of the chatbot across all conversations. They are typically used for configuration and developer information, such as:\n1. Storing the endpoint for the bot's API calls\n2. Saving bot's version number\n3. Storing the bot's name\n4. Metadata about the bot/services\nBot variables are not encrypted or stored securely. Do not save secrets like API keys or passwords in bot variables - use **configuration variables** instead!\nCreating a Bot Variable\n[](#creating-a-bot-variable)\n1. Open up the Variables tab and navigate to the **+** icon in the Variables section.\n2. Change the scope to **Bot**, select the Data Type, give it a name, and click **Add** to create the Variable.\nUsing Bot Variables\n[](#using-bot-variables)\nBot variables can be used in text and other cards just like user variables - with either `@bot.variablename` or `{{bot.variablename}}`.\nSession Variables\n[](#session-variables)\nSession variables are available in all flows, but only for one conversation. These variables are great for data used throughout a conversation, such as:\n1. Collecting items in a virtual shopping cart for the user to order\n2. Saving raw data from an API call for further processing\n3. Storing chat history for that conversation\n4. Saving an order number or policy number\nCreating a Session Variable\n[](#creating-a-session-variable)\nSession variables can only be created inside of an **Execute Code** card.\nTo create one, simply write: `event.state.session.variablename = \"Hello World\"` or for short `session.variablename = \"Hello World\"`\nTo use a Session Variable in a text or other card, enclose it in double curly brackets like `{{event.state.session.variablename}}` or for short `{{session.variablename}}`\nConfiguration Variables\n[](#configuration-variables)\nConfiguration variables are a special kind of secure bot Variable. They can also be managed from the Cloud Dashboard without opening the bot. Configuration variables can store secrets like:\n* API Tokens\n* Private IP Addresses\n* Database usernames and passwords\nCreating a Configuration Variable (or Environment Variable)\n[](#creating-a-configuration-variable-or-environment-variable)\n1. Click the Botpress icon in the upper-left corner and select **Chatbot Settings**\n2. Scroll down and click on the button to add a Configuration Variable. Fill in the Variable's name and value and click **Done**.\nYou can use **env.key** in your code to get the value of the Configuration Variable. To use it in an Execute Code Card, you can write env.key to access its value.\nOnce a configuration Variable is created, you can access and manage it from the cloud admin dashboard. Just select your bot and then click on the tab for **Configuration Variables.**\nPassing Variables between Flows\n[](#passing-variables-between-flows)\n1. In your target workflow, define an input Variable from the workflow properties window.\n2. Toggle it `ON` on the `Entry node` of the target workflow.\n3. Now, on the `exit` node of the parent workflow, the one that brings the user to the target workflow, match the parent workflow Variable with the target workflow input Variable.\n4. Now, when you call the target workflow from the parent workflow, you will see the input Variable in the card. You can pass a value or a Variable to it.\nUsing Variables in Code Card\n[](#using-variables-in-code-card)\nVariables in code follow the pattern `variabletype.variablename`. Here's a breakdown and examples of how to use these:\n1\\. Assigning a Value to a Variable\n[](#1-assigning-a-value-to-a-variable)\nThis is typically how you'd initialize a variable or change its value.\nJavaScript\n`workflow.orderNumber = 12345\nsession.cartTotal = 59.99\nuser.lastName = 'Smith'\nbot.version = '1.2.3'\nenv.databaseURL = 'https://example.com/db'\n`\n2\\. Using Variables in Conditional Statements\n[](#2-using-variables-in-conditional-statements)\nThis checks the value of a variable and executes code accordingly.\nJavaScript\n`if (user.firstName === 'John') {\nconsole.log('Hello John!')\n} else {\nconsole.log('Welcome, user!')\n}\n`\n3\\. Using Variables in Functions\n[](#3-using-variables-in-functions)\nHere, you might pass a variable as a function argument or use it inside a function.\nJavaScript\n`function greetUser(firstName) {\nconsole.log('Hello, ' + firstName + '!')\n}\ngreetUser(user.firstName)\n`\n4\\. Combining Variables\n[](#4-combining-variables)\nYou might want to combine or concatenate variables.\nJavaScript\n`var fullName = user.firstName + ' ' + user.lastName\n//or\nvar welcomeMessage = 'Hello, ' + user.firstName + ' ' + user.lastName + '!'\n`\n5\\. Checking Variable Type\n[](#5-checking-variable-type)\nBotpress might throw an error if types don't match, you can use type checking before assigning values.\nJavaScript\n`if (typeof workflow.userAcctId === 'number') {\nworkflow.userAcctId = 67890 // This is okay.\n} else {\nconsole.error('Invalid type for userAcctId!')\n}\n`\n6\\. Using Variables with External APIs\n[](#6-using-variables-with-external-apis)\nIf your bot interacts with external services, you might use an environment variable like env.apiKey.\nJavaScript\n`` const apiKey = env.API_KEY\nconst apiUrl = env.API_URL\nconst config = {\nheaders: {\nAuthorization: `Bearer ${apiKey}`,\n},\n}\nconst response = await axios.get(apiUrl, config)\nconst data = response.data\n// Process the data as needed\n// ...\n// Example: Log the response data\nconsole.log(data)\n``\nSpecial Variables\n[](#special-variables)\nBotpress makes available several different variables that can be used in your bot's code. These variables are useful for debugging and for accessing information about the user and conversation.\n| Path                                                                             | Type        | Description                                                                                |\n| -------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| event.preview                                                                    | Event       | The last message sent by the user. It will be replaced every time there is a new message.                                                                                |\n| conversation.SummaryAgent.summary                                                | Agent       | Summary of the conversation created by the [Summary Agent](../docs/agents#summary-agent). It's an explanation of what happened.                                                                                |\n| conversation.SummaryAgent.transcript                                             | Agent       | Transcript of the conversation going back a certain amount of turns.                                                                                |\n| turn.KnowledgeAgent.answer                                                       | Agent       | The answer provided by the [Knowledge Agent](../docs/agents#knowledge-agent)                                                                                |\n| turn.KnowledgeAgent.responded                                                    | Agent       | Wether the Knowledge Agent has responded automatically to a user question. Its value will be true or false                                                                                |\n| turn.KnowledgeAgent?.answer?.length                                              | Agent       | The amount of characters in the Knowledge answer. Use this in an [Expression](../docs/transition#expression) to check if there is an answer in the KB. Optionally add ! to start of the code in order to check if there was NOT an answer. |\n| turn.KnowledgeAgent.citations                                                    | Agent       | A list of citations for the Knowledge answer.                                                                                |\n| user.TranslatorAgent.language                                                    | Agent       | The current user language code in ISO 639-1 format. [More about the Translator Agent](../docs/agents#translator-agen)                                                                                |\n| user.TranslatorAgent.language = 'en'                                             | Agent       | This code snippet set's the user language to English. Replace with any language code in the ISO 639-1 format                                                                                |\n| event.kb.results.map((a) => a.dsFriendlyName + '\\\\n' + a.content).join('\\\\n\\\\n') | Event       | This code snippet returns the raw content that generated the final Knowledge answer.                                                                                |\n| event.tags.conversation\\['whatsapp:userPhone'\\]                                  | Integration | The user's phone number on WhatsApp. Includes the international code.                                                                                |\n| event.tags.conversation\\['whatsapp:phoneNumberId'\\]                              | Integration | The phone number Id of the bot on WhatsApp.                                                                                |\nUpdated 4 months ago\n---\n* [Table of Contents](#)\n* * [Variable Scopes](#variable-scopes)  \n         * [Creating Variables in Botpress](#creating-variables-in-botpress)  \n         * [Using Variables in Botpress](#using-variables-in-botpress)  \n   * [Data Types for Variables](#data-types-for-variables)  \n   * [Workflow Variables](#workflow-variables)  \n         * [Creating a Workflow Variable](#creating-a-workflow-variable)  \n         * [Input and Output Workflow Variables](#input-and-output-workflow-variables)  \n   * [User Variables](#user-variables)  \n         * [Creating a User Variable](#creating-a-user-variable)  \n         * [Using User Variables](#using-user-variables)  \n   * [Bot Variables](#bot-variables)  \n         * [Creating a Bot Variable](#creating-a-bot-variable)  \n         * [Using Bot Variables](#using-bot-variables)  \n   * [Session Variables](#session-variables)  \n         * [Creating a Session Variable](#creating-a-session-variable)  \n   * [Configuration Variables](#configuration-variables)  \n         * [Creating a Configuration Variable (or Environment Variable)](#creating-a-configuration-variable-or-environment-variable)  \n   * [Passing Variables between Flows](#passing-variables-between-flows)  \n   * [Using Variables in Code Card](#using-variables-in-code-card)  \n         * [1\\. Assigning a Value to a Variable](#1-assigning-a-value-to-a-variable)  \n         * [2\\. Using Variables in Conditional Statements](#2-using-variables-in-conditional-statements)  \n         * [3\\. Using Varia\nConditional Statements](#2-using-variables-in-conditional-statements)  \n         * [3\\. Using Variables in Functions](#3-using-variables-in-functions)  \n         * [4\\. Combining Variables](#4-combining-variables)  \n         * [5\\. Checking Variable Type](#5-checking-variable-type)  \n         * [6\\. Using Variables with External APIs](#6-using-variables-with-external-apis)  \n   * [Special Variables](#special-variables)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nVonage\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics-agent)  \n   * [Library](/docs/library)  \n   * [Hooks](/docs/hooks)  \n   * [Integrations](/docs/integrations-3)  \n   * [Schemas](/docs/schemas)  \n   * [Card Hub](/docs/card-hub)  \n   * [Versions](/docs/versions-1)  \n   * [Chatbot Settings](/docs/chatbot-settings-1)  \n   * [Find](/docs/find)  \n   * [Variables](/docs/variables)  \n   * [Card Tray](/docs/card-tray)  \n   * [Debugger, Logs & JSON](/docs/debugger-logs-json)  \n   * [Emulator](/docs/emulator)  \n   * [Keyboard Shortcuts](/docs/keyboard-shortcuts)  \n   * [Commands](/docs/studio-commands)  \n   * [Studio Preferences](/docs/studio-preferences)  \n   * [Import & Export](/docs/import-export-bots)\n* [Cards](/docs/cards)  \n   * [Send Messages](/docs/send-messages)  \n   * [Execute](/docs/execute)  \n   * [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n        \n* [Webchat](/docs/webchat-2)  \n   * [Flow Logic](/docs/flow-logic)  \n   * [AI](/docs/ai)  \n         * [AI Task](/docs/ai-task-1)  \n         * [AI Transition](/docs/ai-transition)  \n         * [AI Generate Text](/docs/ai-generate-text)  \n   * [Capture Information](/docs/capture-information)  \n   * [Events](/docs/events-3)  \n   * [Agents](/docs/agents-2)  \n   * [Utilities](/docs/utilities)\n## integrations\n* [Usage](/docs/using-integrations)  \n   * [Asana](/docs/asana-integration)  \n   * [HITL](/docs/hitl-1)  \n   * [Instagram](/docs/instagram)  \n   * [Intercom](/docs/intercom)  \n   * [Line](/docs/line)  \n   * [Messenger](/docs/messenger)  \n   * [Microsoft Teams](/docs/microsoft-teams)  \n   * [Notion](/docs/notion)  \n   * [Slack](/docs/slack)  \n   * [Sunshine Conversations](/docs/sunshine-conversations)  \n   * [Telegram](/docs/telegram)  \n   * [Trello](/docs/trello)  \n   * [Twilio](/docs/twilio)  \n   * [Viber](/docs/viber)  \n   * [Vonage](/docs/vonage)  \n   * [Webhook](/docs/webhook)  \n   * [WhatsApp](/docs/whatsapp)  \n         * [Manual Configuration](/docs/manual-configuration)  \n   * [Zapier](/docs/zapier)  \n   * [Zendesk](/docs/zendesk)\n* [Building](/docs/building-integrations)  \n   * [Getting Started](/docs/getting-started-1)  \n         * [Getting Started](/docs/getting-started-1)  \n         * [Adding Messaging Channel Capabilities](/docs/adding-messaging-channel-capabilities)  \n         * [Adding Actions & Triggers to Botpress Studio](/docs/adding-actions-triggers-to-botpress-studio)  \n         * [Publish your integration on Botpress Hub](/docs/publish-your-integration-on-botpress-hub)  \n   * [Use Your Own LLM](/docs/llm-interfaces)  \n   * [Connect a live agent platform with Botpress](/docs/hitl)  \n   * [Moving Parts](/docs/moving-parts)  \n   * [CLI](/docs/cli)  \n   * [SDK](/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)\n/docs/sdk)  \n   * [Key Concepts](/docs/key-concepts)  \n         * [Architecture](/docs/architecture)  \n         * [Tags](/docs/tags)  \n         * [Channels](/docs/channels)  \n         * [Configuration](/docs/configuration)  \n         * [User](/docs/user)  \n         * [Conversations](/docs/conversations-1)  \n         * [Messages](/docs/messages)  \n         * [Event](/docs/event)  \n         * [States](/docs/states-1)  \n         * [Actions](/docs/actions)  \n         * [Definitions](/docs/definitions)  \n         * [Secrets](/docs/secrets)  \n         * [ZUI - Zod schema UI components in Botpress \\[BETA\\]](/docs/zui-zod-schema-ui-components-in-botpress)  \n   * [How to](/docs/states)  \n         * [States](/docs/states)  \n         * [Register & Unregister](/docs/register-unregister)  \n         * [Integrations Actions](/docs/integrations)  \n         * [Integration Events](/docs/integration-events)  \n         * [Handler](/docs/handler)  \n         * [Logging](/docs/logging)  \n         * [Building a Custom Integration](/docs/building-a-custom-integration)\n## Webchat\n* [Webchat](/docs/webchat)  \n   * [Webflow](/docs/webflow)  \n   * [Wix](/docs/wix)  \n   * [Wordpress](/docs/wordpress)\n* [Webchat v1 (deprecated)](/docs/web-chat-v1old)  \n   * [Controlling Web Chat using JavaScript](/docs/controlling-web-chat-using-javascript)  \n   * [Styling your webchat](/docs/chatbot-button)  \n         * [Chatbot Button](/docs/chatbot-button)  \n         * [Chat Header](/docs/chat-header)  \n         * [User Input Area](/docs/user-input-area)  \n         * [Show Bot Info](/docs/show-bot-info)  \n   * [Embedding Webchat](/docs/react-app)  \n         * [React App](/docs/react-app)  \n         * [React Native App](/docs/react-native-app)  \n         * [Web Chat Iframe](/docs/web-chat-iframe)  \n         * [Full Screen Chatbot](/docs/full-screen-chatbot)\n* [Webchat v2](/docs/embedded-webchat)  \n   * [Embedded Webchat](/docs/embedded-webchat)  \n         * [Custom CSS Reference](/docs/custom-css-reference)  \n   * [React Components](/docs/react-js)  \n   * [Webchat Client](/docs/webchat-client)\n## Botpress APIs\n* [Files API](/docs/files-api)\n* [Chat API](/docs/chat-api)\n## Appendix\n* [Safety](/docs/safety)  \n   * [Preventing Abuse](/docs/preventing-abuse)  \n   * [Brand Safety Framework](/docs/brand-safety-framework)\n* [Exporting Data](/docs/exporting-data)  \n   * [Raw Conversations](/docs/exporting-raw-conversations-with-the-botpress-api)  \n   * [Conversation History](/docs/getting-the-conversation-history-from-within-your-bot)  \n   * [Streaming Analytics](/docs/streaming-analytics-from-within-your-bot-with-hooks)  \n   * [Compiled Bot Analytics](/docs/exporting-compiled-bot-analytics-with-the-botpress-api)\nPowered by\n# Vonage\n[ Suggest Edits](/edit/vonage)\n![](https://files.readme.io/df1acbf-image.png)\nPrerequisites\n[](#prerequisites)\n* A [Vonage Account](https://dashboard.nexmo.com/sign-up)\n* A [Vonage Application](https://dashboard.nexmo.com/applications/new)\n* A [Botpress Cloud account](https://sso.botpress.cloud) and a [Botpress Bot](https://botpress.com/docs/cloud/getting-started/create-and-publish-your-chatbot/)\nSetting up the Vonage integration in Botpress\n[](#setting-up-the-vonage-integration-in-botpress)\n1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).\n2. Find and open the Vonage integration then click on the \"Install to Bot\" button, now go back to your bot.\nSetting up Vonage\n[](#setting-up-vonage)\nAPI credentials\n[](#api-credentials)\n1. Go to your [API Settings](https://dashboard.nexmo.com/settings).\n2. Copy paste the API key to the **API Key** channel configuration\n3. Copy paste the API secret from the **Account credentials** section to the **API Secret** channel configuration\n4. Copy paste the signature secret from the **Signed webhooks** section to the **Signature Secret** channel configuration\nSave Configuration\n[](#save-configuration)\nChannel configuration is complete, you can now click **Save**\nWebhook Configuration\n[](#webhook-configuration)\nSandbox\n[](#sandbox)\nYou can use the Vonage sandbox to test you channel with WhatsApp\n1. Check the **Use Testing API** box in your channel configuration\n2. Go to your [Sandbox Settings](https://dashboard.nexmo.com/messages/sandbox)\n3. Copy paste the webhook url provided in the channel configuration UI to the **Inbound** and **Status** fields in the **Webhooks** section\nThat's it, you may now start chatting with your bot on Vonage!\nUpdated 4 months ago\n---\n* [Table of Contents](#)\n* * [Prerequisites](#prerequisites)  \n   * [Setting up the Vonage integration in Botpress](#setting-up-the-vonage-integration-in-botpress)  \n   * [Setting up Vonage](#setting-up-vonage)  \n         * [API credentials](#api-credentials)  \n         * [Save Configuration](#save-configuration)  \n   * [Webhook Configuration](#webhook-configuration)  \n         * [Sandbox](#sandbox)[Jump to Content](#content)\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\n---\n[![Botpress](https://files.readme.io/c8cb63b6d586cd66085b4c960570959a424c7050c5ffeb0aeaf31711e2e1b2ac-small-BPLOGO_new_dark_1.png)](https://botpress.com)\nGuides\nMoon (Dark Mode)Sun (Light Mode)\n[Guides](/docs)[API Reference](/reference)[Changelog](/changelog)\nUsage\nSearch\n## Home\n* [Botpress Documentation](/docs/home)\n## Getting Started\n* [Build](/docs/build)\n* [Deploy](/docs/deploy)\n* [Monitor](/docs/monitor)\n## DASHBOARD\n* [Workspace](/docs/workspace)  \n   * [Home](/docs/home-1)  \n   * [Members](/docs/members)  \n   * [Audits](/docs/audits)  \n   * [Your integrations](/docs/your-integrations)  \n   * [Usage](/docs/usage-2)  \n   * [Settings](/docs/settings)  \n   * [Profile Setting](/docs/user-profile)\n* [Bot](/docs/bot)  \n   * [Overview](/docs/overview-1)  \n   * [Integrations](/docs/integrations-1)  \n   * [Webchat](/docs/webchat-1)  \n   * [Logs](/docs/logs)  \n   * [Conversations](/docs/conversations)  \n   * [Analytics](/docs/analytics-1)  \n   * [Events](/docs/events-2)  \n   * [Issues](/docs/issues)  \n   * [Configuration variables](/docs/configuration-variables-1)\n## STUDIO\n* [Interface](/docs/interface)  \n   * [Nodes](/docs/nodes)  \n   * [Home](/docs/home-2)  \n   * [Flows](/docs/studio-interface-flows)  \n   * [Knowledge Base](/docs/knowledge-base)  \n   * [Tables](/docs/tables)  \n   * [Agents](/docs/agents)  \n         * [Summary Agent](/docs/summary-agent)  \n         * [Personality Agent](/docs/personality-agent)  \n         * [Policy Agent](/docs/policy-agent)  \n         * [Translator Agent](/docs/translator-agent)  \n         * [Knowledge Agent](/docs/knowledge-agent)  \n         * [HITL Agent](/docs/hitl-agent)  \n         * [Vision Agent](/docs/vision-agent)  \n         * [Analytics Agent](/docs/analytics\n<|new_information|>","role":"user","type":"text"}],"meta":{"integrationName":"zai","promptCategory":"zai:summarize","promptSource":"zai:summarize:default"},"model":"fast","signal":{},"stopSequences":["■END■"]},"method":"POST","url":"https://api.botpress.cloud/v2/cognitive/generate-text"}

Output:
■START■
# Botpress Documentation – High‑Level Overview

## 1. Core Areas

| Area | What you’ll find |
|------|------------------|
| **Getting Started** | Build, Deploy & Monitor bots; create and publish a Botpress Bot. |
| **Dashboard** | Workspace admin (members, audits, integrations, usage, settings, profile). |
| **Bot Management** | Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables. |
| **Studio** | Visual flow editor (nodes, flows), Knowledge Base, Tables, Agents (summary, personality, policy, translator, knowledge, HITL, vision, analytics), Library, Hooks, Card Hub, Versions, Bot Settings, Debugger, Emulator, Keyboard shortcuts, Commands, Preferences, Import/Export. |
| **Cards** | Send Messages, Execute code, Webchat, Flow Logic, AI. |
| **Integrations** | Ready‑made channels (Asana, HITL, Instagram, Intercom, Line, Messenger, MS Teams, Notion, Slack, Sunshine, Telegram, Twilio, Viber, Vonage, Webhook, WhatsApp, Zapier, Zendesk) plus a **Building** guide (SDK, CLI, custom integrations, LLM use, architecture). |
| **Webchat** | • **v1 (deprecated)** – JavaScript control, styling, embed options (React, iFrame, full‑screen).
• **v2** – Embedded Webchat, React components, Webchat client, custom CSS.
• **Installation** via Integration Hub, Shareable URL, Pre‑configured script (recommended) or Configurable script (manual updates). |
| **Botpress APIs** | Files API, Chat API. |
| **Appendix** | Safety (abuse prevention, brand safety), Exporting data (raw conversations, history, streaming analytics, compiled analytics). |

## 2. Webchat Details (most‑used feature)

- **Installation** – Add through Integration Hub → “Install to Bot”.
- **Embedding options** – Pre‑configured script (paste into `<body>`), Configurable script (manual parameter edits).
- **Configurable Parameters** (selected defaults):

| Parameter | Description | Default | Type |
|-----------|-------------|---------|------|
| `stylesheet` | Custom CSS path | – | string |
| `showConversationsButton` | Hide conversation list | `true` | boolean |
| `showTimestamp` | Show timestamps | `false` | boolean |
| `enableTranscriptDownload` | Allow transcript download | `true` | boolean |
| `closeOnEscape` | Close on Esc key | `true` | boolean |
| `botName`, `avatarUrl`, `botConversationDescription` | Branding info | – | string |
| `locale` | Force UI language (`en`, `fr`, …) | `'browser'` | string |
| `hideWidget`, `disableAnimations`, `useSessionStorage` | UI/behavior tweaks | `false` | boolean |
| `containerWidth`, `layoutWidth` | Width of the widget | `360` | string/number |
| `enablePersistHistory` | Persist messages locally | `true` | boolean |
| `disableNotificationSound` | Silence new‑message sound | `false` | boolean |
| `googleMapsAPIKey` | Show maps in chat | – | string |
| `website`, `phoneNumber`, `termsConditions`, `privacyPolicy`, `emailAddress`, `coverPictureUrl` | Footer info pages | – | string |
| `showBotInfoPage`, `showCloseButton` | Show extra UI buttons | `false` / `true` | boolean |
| `userData`, `customUser` | Pass extra data to bot | – | object |

- **Domain Whitelisting** (Team plan only) – restricts which domains may host the widget. Add allowed origins under *Advanced Settings* → *Allowed Origins*.

## 3. Variables – Scoped Data Storage

| Scope | Typical Use |
|------|-------------|
| **Workflow** | Temporary data inside a single flow (e.g., AI task output, user answers). |
| **Session** | Data lives for the duration of a conversation (e.g., cart items). |
| **User** | Persists across sessions for a particular user (profile, preferences, tags). |
| **Bot** | Global config accessible to all users (bot name, version). |
| **Configuration** (secure) | Secrets & environment variables (API keys, DB credentials). |

All variables are typed (String, Boolean, Number, Date, Object, Array, Enum, Pattern) and can be accessed in cards via `{{scope.varName}}` or `@scope.varName`.

## 4. Usage & Limits

- **AI Spend** – Token‑based billing, free $5/month, cap $100/month (adjustable on dashboard).
- **File Storage** – MB used for media files.
- **Table Rows** – Number of rows across bot tables.
- **Vector DB Storage** – MB of vectorized knowledge‑base data (RAG).
- **Incoming Messages & Events** – Count of invocations before throttling.
- **Collaborators** – Max users in a workspace.
- **Bots** – Max bots per workspace (3 for pay‑as‑you‑go, 15 for Team plan).
- **Always‑Alive** – Reserve a warm instance to avoid cold‑start latency (per‑bot purchase).

## 5. Version Control

- Access via the clock‑icon in the left menu.
- **Create** manually (`+`) or automatically on each publish.
- **Revert** to any saved version (overwrites current state).
- Plan limits: 3 versions (pay‑as‑you‑go) or 15 (Team).

## 6. Profile & Security

- Update avatar, name, link social accounts, change password, generate personal access tokens.
- **Safety** – Prevent abuse and follow brand‑safety framework.

## 7. Export & Analytics

- Export raw conversations, conversation history, streaming analytics, compiled bot analytics via the Exporting Data section.

---

**Bottom Line** – Botpress provides a full‑stack, low‑code platform covering:

1. **Bot creation & deployment** (Dashboard, Studio, Versions).
2. **Rich UI & channel integrations** (Webchat v1/v2, dozens of pre‑built Messaging channels, custom integrations).
3. **Data handling** (Variables, storage limits, export tools).
4. **Operational insight** (Usage metrics, AI spend, safety, version history).

This overview captures all major documentation sections without diving into any single feature, giving a complete horizontal map of what Botpress offers.