# Overview

Welcome to Captivate Chat!

<figure><img src="/files/mgrnc5Vp1lUekIOuBwuf" alt=""><figcaption></figcaption></figure>

## What is Captivate?

**Captivate** provides various AI solutions that transform the enterprise. As your AI development partner, we harness the power of AI alongside your processes, expertise, and data.&#x20;

Whether you're a digital leader aiming to unify your systems or a sales leader aiming to accelerate deal velocity, Captivate equips you with the tools to transform your sales delivery and leverage AI's incredible potential.

Captivate empowers your team through these main AI solutions:

* **Captivate Vienna:** Serving as our enterprise AI orchestration layer, Vienna connects, governs, and manages every AI agent, data source, and workflow across your organisation.
* **Captivate Athena:** The AI sales execution platform that supports reps before, during, and after every sales meeting with call prep, live prompts, and automated follow-up.&#x20;

Captivate is your go-to solution for bringing AI's power to your organisation.

***

## Core Benefits

* **Vendor Neutral**: Never locked into single technology
* **Flexible Middleware**: Adapts to your workflow
* **Scalable**: Small teams to enterprise deployments
* **Custom Integration**: 7,000+ via Zapier plus bespoke development


# Components

How does Captivate work?

**Captivate** is built on a flexible middleware system that integrates AI chatbots, live chat platforms, and communication channels into a unified platform.&#x20;

Whether you're coordinating the usage of your AI tools via our **Vienna** AI orchestration engine or building custom applications like our clients or using our flagship **Athena** sales acceleration engine, Captivate's components work together seamlessly to power your AI-driven solutions. Here's how each component works:

***

## Applications

Our clients are building their own applications using Captivate's platform but we've built **Athena**, our revolutionary AI sales acceleration application. You can also coordinate your AI tools with **Vienna**, our AI orchestration engine. Here's how everything works from a top-down perspective:&#x20;

### Vienna

Vienna is the AI orchestration engine at the heart of the Captivate platform, designed to offer a vendor-neutral approach to managing all your AI tools. Here are its main components:&#x20;

* **Lifecycle Management:** Vienna treats AI agents and conversational workflows as modular components, enabling enterprise-grade change management.&#x20;
* **AI Router:** Use Agent Groups to "link" AI agents together, so Vienna can re-route users to the appropriate AI agents based on the context of their queries.&#x20;
* **Governance and Compliance:** Vienna enforces robust security and compliance controls across your entire conversational AI infrastructure. Our governance layer provides: ​
  * **Role-Based Access Control (RBAC):** Granular permission management ensuring users only access what they need.
  * **Compliance:** Evaluate AI agents based on legislative and regulatory rulesets.
* **Objects (ETA 2026):** Transform AI agents, workflows, and guardrails into modular components that can be transferred across users and organisations.&#x20;
* **Vienna Insights (ETA 2026):** Obtain insights regarding your conversations, focusing on key metrics you want to track. You can input your desired parameters using natural language, and Vienna can generate the relevant dashboards and visual components to best present the information.

### Athena

Athena is the intelligent sales execution engine of Captivate, serving as your team's virtual sales assistant built to support sales professionals at every stage of their workflow. It has these main components:

* **Knowledge Bot:** This is an AI agent trained on all your relevant marketing and sales materials.&#x20;
* **Mini-Courses:** Athena can help you create personalised Mini-Courses based on your ingested materials and other relevant context. These are five-minute short courses with a Knowledge Test to ensure you're actively learning at any pace you wish.&#x20;
* **Call Pilot:** This is our meeting planner, where you can transform meetings into dynamic "Athena Calls" that affect every aspect of the sales conversation through three modules: &#x20;
  * **Before** - Generates real-time call briefings from CRM, email, calendar, and news sources, plus delivers bite-sized training based on conversation needs
  * **During** - Provides AI live sales support with instant product details and real-time audio analysis for upsell opportunities and objection handling
  * **After** - Automates CRM updates, follow-up scheduling, contact reports, and conversation-based email generation
* **Athena Insights (ETA 2026):** Athena can analyze conversations you've had with both the Knowledge Bot and the Call Pilot and provide meaningful insights based on various parameters such as sentiment, intent, and other relevant metrics.

### Your Company

Companies can use Captivate as the foundation to develop their own AI-powered apps by leveraging its flexible SDK, API, and prebuilt components for rapid customisation.

***

## Integrations

### Chat Flows

The **Chat Flow** is the core of Captivate. It seamlessly brings together AI Chatbots, Channels, and Live Chat into one cohesive system. At the heart of Captivate is Chat Flow, allowing businesses to:

* Assign an AI to a specific channel
* Enable live chat escalation when needed
* Deploy the same AI assistant across multiple channels

When you create a Chat Flow with Captivate, it manages all necessary integrations—ensuring that all human-machine conversations across its connections are compatible and interchangeable.

### AI Chatbots

An **AI Chatbot** is a computer program designed to simulate human conversations through text or voice interactions. Within Captivate, you can integrate your existing AI Chatbots or create new ones. Our platform supports the following AI Chatbot infrastructures:

* **OpenAI** – GPT-powered AI for natural language conversations
* **Custom Chatbot** – We can create a personalised LLM to fulfil your specific objectives

### Channel

A **Channel** is the platform that your users access to get information about your company and avail your services. Using a Chat Flow, you can deploy your AI Chatbot in these Channels to assist users with their concerns.

Available Channels include:

* **Web Widgets** – Embed AI-powered chat on your website
* **WhatsApp** – Automate customer support via messaging
* **Social Media** – Seamless integration with Facebook Messenger and Instagram
* **Custom Channel** – Our team can create a personalised Channel for your preferred deployment area

### Live Chats

**Live Chats** pertain to messaging platforms with special app integration features. Thanks to Chat Flows, we can use Live Chats to provide real-time contact between your agents and the users that your AI Chatbots are conversing with.

Your Chat Flow is programmed to analyse incoming messages from various Channels, directing them to Chatbots for general responses and to Live Chat agents for specialised answers. Currently supported platforms include:

* **Microsoft Teams** – Ideal for customer support and internal collaboration
* **Slack** – Organised team communication with third-party integrations
* **Custom Live Chat** – The Captivate team can create a custom-tailored Live Chat for your team

### Systems Integrations

Captivate supports Zapier AI Actions, unlocking access to 7,000+ integrations with business tools.

***

## Platform

Captivate is built on a unique chat routing middleware, designed to seamlessly route conversations between any AI, channel, or live chat platform whilst eliminating vendor lock-in, giving businesses complete flexibility.

* **Open & Flexible** – Integrate with any AI, live chat, or CRM system
* **Enterprise-Grade Security** – Encryption, anonymisation, and full compliance
* **Scalable** – Suitable for small businesses and large enterprises alike
* **Deploy Anywhere** – Cloud-based or on-premises hosting options
* **Custom AI Models** – Integrate DeepSeek, Gemini, OpenAI, Anthropic, DeepMind, and more
* **Flexible Channels** – Add TikTok, Signal, Telegram, and other platforms as needed
* **CRM Integration** – Connect with Zoho, Eloqua, HubSpot, and any modern system
* **Bespoke Development** – Custom web and mobile chat experiences built by our expert team

We've been building AI chat platforms for nearly a decade, with skilled AI engineers and developers who can rapidly create cost-effective solutions. For businesses that want complete control over their AI strategy, Captivate offers the perfect blend of off-the-shelf functionality and full customisation—without vendor lock-in.


# Changelog

All changes to the Captivate platform will be added here. Guides will be updated concurrently.

***

## v5.0.4

### 📆2025-12-05

### ⚠️ Fixed

* **Athena**
  * **General**
    * **Athena bot late attendance:** Fixed a bug where Athena is late in calls.&#x20;
  * **During**
    * **Late transcriptions:** Fixed a bug where live transcriptions are not being updated as the call happens.
    * **AI Suggestions errors:** Fixed a bug where AI Suggestions aren't appearing despite having an in-depth transcript.&#x20;
  * **After**
    * **Meeting scheduling errors:** Fixed a bug where meetings aren't being scheduled based on the date and time provided.&#x20;

### 📆2025-11-20

### ✅ Added

* **Athena**
  * **General**
    * **Opportunity Name:** Calls in Athena are now organised into a group of meetings called an "Opportunity" - a reflection of the fact that securing a deal with a company doesn't just happen within a single meeting, but often in a series of calls.&#x20;
  * **Before**
    * **Invite Athena to meetings manually:** Users can now invite the Athena bot into the specific call with a button.&#x20;
    * **More manual editable features:** Before module now has more manually-editable features, making meeting setups much easier.&#x20;
  * **During**
  * **After**&#x20;
    * **Meeting Scheduler:** The After module now includes the ability to schedule next meetings, with the date and time either lifted from the transcript or manually set up by users.&#x20;

### 🟧 Changed

* **Athena**
  * **General**
    * **Tighter text:** Made sure that text throughout the Athena platform are succinct and brief to aid users get information as fast as possible
    * **Light mode:** Light mode now selected as default color
    * **No more auto-inviting Athena:** With the button to invite Athena now existing in Before, it's up to users to manually invite Athena into their meeting as they see fit.&#x20;
  * **Before**
    * **Mini Course sources improvement:** Mini Course now also use the Meeting Description and the core Knowledge Bot as a basis of its topics.
  * **During**
    * **AI Suggestion page finder:** A textbox exists should users want to switch to a very specific suggestion they have encountered, and if they remember the page.&#x20;

### ⚠️ Fixed

* **Athena**
  * **General**
    * **Registration errors:** Fixed a bug that results in faulty registration.&#x20;
  * **Call Pilot**
    * **Name change:** "Call Planner" is now named "Call Pilot"
    * **Email additions error:** Fixed a bug where adjusting attendees in the main calendar doesn't reflect in the Call Planner.
  * **Before**
    * **Mini Course appearance:** Fixed bugs that don't cause the Mini Course to appear based on different actions.
  * **During**
    * **Live Transcription error:** Fixed a bug that doesn't make the transcript update itself live during a call.
    * **AI Suggestions appear too quickly:** Fixed a bug that caused many Live Suggestions to appear.&#x20;
  * **After**
    * **Retention error:** Fixed an error that removes a pre-existing generated After report.&#x20;

### 📆2025-10-30

### ✅ Added

* **AI Chatbots**
  * **Compliance!** A new integration that allows users to test the quality of their AI Chatbots based on specific standards.&#x20;

### ⚠️ Fixed

* **General**
  * **Inconsistent Registration:** Fixed an error where accounts aren't properly registering in the platform.
  * **Email Fixes:** Fixed the text that appears during registration emails.&#x20;
* **Agent Groups**
  * **Agent Group Listing:** Fixed a bug where Agent Groups don't appear in the list after making them.
* **Captivate Organisations**
  * **Same Company, different Organisation:** Fixed a bug where the same company has two different Organisations with user lists.

### 📆2025-10-16

### ✅ Added

* **Chat Flows**
  * **Athena User and Mini Course List:** Have an interface within the Chat Flows view that lets users obtain a list of registered users in an Athena as well as the list of Mini Courses generated in an Athena.
* **Athena**
  * **General**
    * **Edit with AI:** Most items in the Before/During/After modules can be edited with AI using a simple text prompt.&#x20;
  * **Call Calendar (Call Pilot)**
    * **Calendar Syncing:** Users can see their calendars linked within the Call Calendar (Call Pilot), with non-Athena calls marked grey and Athena calls marked blue. Athena calls can be organised and utilised in live conversations as a **Call Plan**.&#x20;
  * **Before**
    * **Meeting Description:** Non-Athena calls that users want to transform into Athena calls will prompt users to add a Meeting Description that will be used as a basis of the meeting information.
    * **Build Call Plan:** Athena can now build **Call Plans** based on the Meeting Description. The main "starting information" of a Call Plan is located within the Before module. The Call Plan will provide information like agenda items, predicted objections, analysed pain points, as well as background data of companies and contacts involved in the call.&#x20;
  * **During**
    * **Pull data from Before:** Ticked items from Before are carried over in During.&#x20;
    * **Embedded Assistant:** The Knowledge Bot can now be accessed in the During module as a chatbot that users can converse with during meetings.
    * **Live Transcript:** An Athena bot will automatically join a designated Athena meeting and begin transcribing the call.&#x20;
    * **AI Suggestions:** The Knowledge Bot can offer live suggestions based on the transcript of the call.&#x20;
    * **Generate After/Re-Generate After:** Users can generate an After module report based on the current transcript with the "Generate After". Meanwhile, existing After reports could be overwritten with "Re-Generate After" - useful when the initial After report has been created while a call is ongoing.&#x20;
  * **After**
    * **AI-based drafting:** Based on the transcript of the call, Athena will create a meeting summary, draft follow-up emails, and suggest action items.&#x20;

### ⚠️ Fixed

* **Athena**
  * **General**
    * **Text fixes:** Tightened the language across the platform
  * **Call Planner**
    * **Inconsistent call details:** Fixed a bug where the Host and Attendees are being shown incorrectly
    * **Inconsistent calendar visualisation:** Fixed some visual errors where some details are not showing up properly.&#x20;
  * **During**
    * **Visual fixes in transcription:** Fixed a bug that makes it difficult to see the actual transcript of the call.&#x20;
    * **Athena avatar for the bot:** The attendee bot to take transcriptions now use the official Athena avatar for easy identification.&#x20;
    * **Live Suggestions navigation:** Navigating the Live Suggestions interface has become easier with new buttons.&#x20;

### 🆕 Introducing Call Pilot (Athena)&#x20;

<figure><img src="/files/MoAFihAAvsH059whNE10" alt="A preview of the Captivate Athena interface, showcasing the view of the main Athena Chat alongside the Mini Course Library, Suggested Questions, Call Pilot, Feedback, and Tutorials."><figcaption><p>A preview of the Captivate Athena interface, showcasing the view of the main Athena Chat alongside the Mini Course Library, Suggested Questions, Call Pilot, Feedback, and Tutorials.</p></figcaption></figure>

**Call Pilot** (previously the "Call Calendar") is the most integral part of Captivate Athena's AI sales execution functionality, as it's the feature that directly ties into sales assistance. Aside from studying materials via Mini Courses and conversing with the Knowledge Bot, it's the Call Pilot where users can plan and engage in their calls with Captivate's proprietary AI sales execution assistance.&#x20;

* **Call Pilot:** After connecting your calendar, Call Pilot lets you transform meetings into "Athena calls" that offer AI assistance in any stage of the call process.&#x20;
* **Call Plan:** When accessed in preparation for a meeting, an Athena call is known as a **Call Plan**. They contain:
  * **Before Module:** This is your pre-call study layer, where AI takes your meeting description and surfaces contact information, company information, agenda items, pain points, potential objections, and meeting-focused Mini Courses that you can study.
  * **During Module:** This is your in-call layer, where AI can generate live transcripts and provide live suggestions based on both context and items selected in the Before Module.&#x20;
  * **After Module:** This is the post-call layer, where AI can take the existing call's transcript and organise next steps. These include auto-updating the CRM as well as providing a call summary, creating a draft email to be sent after the call, listing tasks to be distributed across attendees, and even scheduling the next call.&#x20;

### 📆2025-09-22

### ✅ Added

* **Captivate Organisations:**
  * **RBAC (Role-Based Access Control):** Users can now become part of an organisation when they join Captivate via any work email. They can invite users, as well as create and edit roles with Read, Write, and Delete features. Features are divided across User Management, User Role Management, Chat Flows, Reports, and Chat Transcripts.&#x20;

***

## v5.0.3

### 📆2025-08-22

### ✅ Added

* **AI Chatbots**
  * **Custom Tags & Metadata (for&#x20;*****AI Chatbot > Add Data*****):** Allow users to filter ingested docs using custom keywords. You can test this in the Import Your Information/Add Data step of AI Chatbot creation.

### 🆕 Custom Tags and Metadata

<figure><img src="/files/ktBfZvt1yslCQERn5rwn" alt="After uploading new data in AI Chatbots > Import Your Own Information, you will be prompted if you want to add metadata. This &#x22;Add New Metadata tags&#x22; menu is where you will set metadata identifiers so your data is easily organised and sorted."><figcaption><p>After uploading new data in AI Chatbots > Import Your Own Information, you will be prompted if you want to add metadata. This "Add New Metadata tags" menu is where you will set metadata identifiers so your data is easily organised and sorted.</p></figcaption></figure>

You can now sort ingested information using metadata tags. This is extremely useful for large quantities of content, as you can now add categories (**Metadata Tag**) and identifiers **(Value)** that the platform can auto-assign to relevant content. You may freely edit this within ***AI Chatbots > Importy Your Own Information.***&#x20;

***

## v5.0.2

### 📆2025-08-14

### ✅ Added

* **General**
  * **AI Agent Groups (Beta):** With Developer Mode on you can now create AI Agent Groups comprised of many AI Chatbots. Attach this to your Chat Flow and your conversations get auto-routed to the appropriate AI Chatbot.&#x20;
* **AI Chatbots**
  * **Enable Mini Course Integration (AI Chatbot > Integration):** Start creating Mini Courses based on your bot’s ingested knowledge.

### 🆕 Agent Groups (Beta)

<figure><img src="/files/hrqgVd3Xac4mS8r1K7yx" alt="The &#x22;Agent Group&#x22; window showing a specific Agent Group. When showing the details of an Agent Group, users can see the Agents (AI Chatbots) selected for the group, their original AI Chatbot names, their Provider (LLM), and Example Queries used to toggle the AI router to switch between them."><figcaption><p>The "Agent Group" window showing a specific Agent Group. When showing the details of an Agent Group, users can see the Agents (AI Chatbots) selected for the group, their original AI Chatbot names, their Provider (LLM), and Example Queries used to toggle the AI router to switch between them.</p></figcaption></figure>

**Agent Groups** make use of the platform's unique AI router feature, where users can be rerouted to appropriate sources of information (AI Chatbots/Agents) based purely on context. With Developer Mode turned on, users can group existing AI Chatbots into an Agent Group. This Agent Group becomes the equivalent of an "AI Chatbot" that can be used within a Chat Flow.&#x20;

Instead of choosing just one AI Chatbot with limited knowledge, an Agent Group is the "representative" of a network of AI Chatbots.&#x20;

### 🆕 Enable Mini Course Integration

<figure><img src="/files/lXyywFpsbTCVe2Je1V8S" alt="&#x22;Mini Course Integration&#x22; window as accessed via AI Chatbots > Integration > Mini Course. This is the main menu that activates the course generation API of Captivate, allowing an AI Chatbot to create Mini Courses when attached to an Athena Channel."><figcaption><p>"Mini Course Integration" window as accessed via AI Chatbots > Integration > Mini Course. This is the main menu that activates the course generation API of Captivate, allowing an AI Chatbot to create Mini Courses when attached to an Athena Channel.</p></figcaption></figure>

Users can now designate any AI Chatbot as a source of Mini Courses when attached to an Athena Channel.&#x20;

Accessed within ***AI Chatbots > Integration > Mini Course***, any AI Chatbot with this integration enabled can be used with an Athena, with the chat interface now allowing users to create 5-minute bite-sized Mini Courses about any information ingested by the chatbot.&#x20;

***

## v5.0.1

### 📆2025-08-04

### ✅ Added

* **General**
  * **Developer Mode:** Users can now enjoy more advanced features from Captivate by toggling the Developer Mode in their Account Settings.
* **AI Chatbots**
  * **External Bots:** Use an API endpoint to turn third-party chatbots into bots compatible with Captivate Chat Flows. This selection can be toggled once Developer Mode is activated.    \
    Add Data supports more file types: Aside from PDFs and URLs, you can now upload DOCX, XPS, RTF, TXT, PPTX, XLSX, XLS, and CSV files.
  * **Markdown format now set as default:** Get more visually-consistent conversations with Captivate bots as we've set Markdown as the default format of responses.    \
    Select Type Summarized View: Identify your AI Chatbot's selected chatbot Type easier with the modified Select Type view. Users will also receive a warning before choosing another Type.
* **Chat Flows**

  * **Atomization of edits:** Editing Chat Flows will now open a selector that lets you choose which specific Chat Flow component you want to edit - whether the AI Chatbot, Channel, Livechat, or all of them at once.
* **Athena**

  * **Product Rename:** The **"Full Chat"** Channel is now **Athena**, our AI sales execution platform. Create a mini-site within our platform that allows you to focus on selling, complete with our sales execution suite.&#x20;

  * **Badges now available:** Passing a Knowledge Test now rewards users with a course Badge. They no longer will be able to retake the Knowledge Test.

  * **Add Feedback options:** Create a list of suggested subject lines and emails where user feedback is automatically sent, allowing you to respond to user suggestions and complaints much faster.

  * **Add Terms and Conditions:** Attach Terms and Conditions to your Full Chat to accommodate specific legal requirements by your team.

  * **Start Chat Toggle (You and AI):** Use a toggle to choose whether you or your AI Chatbot will start a conversation in your Full Chat. This is set to your AI Chatbot by default.

  * **Multi-Select Languages:** Choose which languages you want your Full Chat to appear in, auto-translating components based on the language the user selects.    \
    Back to Library button: Use a "Back" button inside a Mini Course to go back to your Mini Course Library.

  * **Sidebar View Toggle:** Hide the Full Chat sidebar to get a more focused view of your current section.

  * **Unread Chats now numbered: Y**ou can now see the number of unread chats in your Full Chat within the dedicated "Unread Chats" part of the interface.

### 🟧 Changed

* **Chat Flows**
  * **Full Chat icon is now Athena: Y**ou will now see Athena's headshot as the icon for Full Chat.    \
    Add Suggested Questions for your Full Chat: Create Suggested Questions for your Full Chat users, giving them examples of prompts to ask your AI Chatbot.
  * **Updated Full Chat subdomain URLs:** Full Chats created in Captivate now appear as "\[subdomain].athena.captivate.com"
  * **Suggestion Questions lead straight to chats:** Clicking a Suggested Question in your Full Chat will now create a new chat with your bot, with that specific question as your first query.
  * **Unique Knowledge Test per take:** Knowledge Tests now feature non-repeating questions and answers, ensuring every test iteration is different.
  * **Notifications are now clickable:** Clicking a Notification will send you to the conversation associated with it, letting you access responses much faster.

### ⚠️ Fixed

* **General**
  * **Removed legacy dependencies:** We have removed legacy dependencies from our codebase repository, as most of them are either broken or outdated.
* **AI Chatbots**
  * **Incorrect token count:** Fixed instances of incorrect token counts being reflected on specific bots.    \
    Estimated Token Cost on Add Data: Fixed an error where ingested files are auto-computed for token consumption. Now, only selected files for pre-ingestion will get an Estimated Token Cost.
*

```
**Athena**
```

```
* **Visual fixes:** Adjusted the extra space to Tools selections, fixed theme color errors, correct profile images reflected across conversations and settings, renamed components for better UX.
* **Chat rename on refresh:** Fixed instances where new chats are auto-renamed on refresh. New chats now automatically get renamed based on conversation context as users converse with AI Chatbots.
* **Double language options**: Fixed a bug that causes the appearance of multiple instances of the same language in the Language selection dropdown.
```

### 🆕 Full Chat is now Athena

<figure><img src="/files/sQ0dk7eEhkk1177cBKlN" alt="A preview of the Captivate Athena interface, showcasing the view of the main Athena Chat alongside the Mini Course Library, and Feedback."><figcaption><p>A preview of the Captivate Athena interface, showcasing the view of the main Athena Chat alongside the Mini Course Library, and Feedback.</p></figcaption></figure>

We've renamed our Full Chat channel into **Athena**, our AI sales execution platform.

When you create an Athena inside ***Chat Flow > Channels***, we will provide a "mini-site" you and your sales representatives can use to help your sales process. It comes with these features:

* **Knowledge Base:** The AI Chatbot attached to the Athena will become the primary Knowledge Base of your Athena. Conversations here will be based on knowledge ingested by your AI Chatbot, so you can create a dedicated AI Chatbot for your Athena that will ingest your marketing and sales materials.&#x20;
* **Mini Course:** Through the ***AI Chatbot > Integration > Mini Course*** feature, your AI Chatbot can create bite-sized Mini Courses that Athena users can study in preparation for their sales calls. These Mini Courses will be based on your AI Chatbot's knowledge.

***

## v4.0.0

### 📆2025-03-21

### ✅ Added

* **Full Chat Channels are live!** If you want your AI Chatbot to have a dedicated webpage, you can finally create a full-sized messaging page with our Full Chat Channels.&#x20;
* **Markdown now supported by Web Chats!** Expect more visual flair when conversing with our Web Chats thanks to markdown language support.&#x20;
* **Speech Options make Web Chats for accessible!** Use Speech Options with Web Chats to add options to talk to AI Chatbots with your built-in microphone or even hear their responses.&#x20;
* **Other Options provide more customizability to Web Chats!** Customize more specific aspects of your Web Chat such as strings that indicate *"text sent by"* or text to *"download transcript*."&#x20;

### 🟧 Changed

* **Transcripts**
  * **Replaced Name with Last Chat Message:** Instead of listing the *Name* of the users who conversed with an AI Chatbot in the Transcripts, we're listing their *Last Chat Message* instead.&#x20;
* **Import Your Own Information**
  * **More Filter Options:** You can now sort your data more intuitively with updated filter options inside AI Chatbots > Add Information. In the Import Your Own Information window, you can now filter columns in ascending or descending order, and filter the types of data displayed based on their status.&#x20;
  * **File Folders with URL Crawler:** Use Captivate Chat's built-in URL Crawler feature to find file folders, making the data ingestion process more efficient.&#x20;

### ⚠️ Fixed

* Fixed a bug where the button to request for Live Agents are not visible when opened using Safari.
* Fixed a bug that doesn't reset the checkbox of a deleted Transcript.
* Fixed a bug where mass ingestion via Chatbot > Add Information suddenly stops while still incomplete.
* Fixed a bug where ingestion via Chatbot > Add Information didn't make any progress at all.

### 🆕 Full Chat Channels will dedicate a webpage for your AI Chatbot

<figure><img src="/files/yHIbITVq4419wvHkhF7z" alt="Create a &#x22;Full Chat&#x22; Channel within Chat Flows > Channels will set up an AI Chatbot that occupies an entire webpage. "><figcaption><p>Create a "Full Chat" Channel within Chat Flows > Channels will set up an AI Chatbot that occupies an entire webpage. </p></figcaption></figure>

While our Web Chat Channels can be expanded to occupy a larger portion of your screen, they're still technically a part of whatever page you assigned them to.&#x20;

This all changes with **Full Chat Channels**, as this lets you set up an AI Chatbot that will occupy an entire webpage! You can finally direct your users to a webpage dedicated to a chatbot - great for interactive sessions!&#x20;

### 🆕 Markdown Syntax now supported by Web Chats

<figure><img src="/files/rU4NH8xQKjnDI1S9CCx5" alt="Web Chats now support Markdown syntax, allowing AI Chatbots to provide more structured and visually appealing responses."><figcaption><p>Web Chats now support Markdown syntax, allowing AI Chatbots to provide more structured and visually appealing responses.</p></figcaption></figure>

Our Web Chats now support **Markdown** syntax, allowing AI Chatbots to provide more structured responses. Enjoy tables, headers, and other formatting options when conversing with your AI Chatbots.

### 🆕 Customize Web Chats further with Other Options!

<figure><img src="/files/sAPm5FoUqd5faixAjYxr" alt="The &#x22;Other Options&#x22; menu under Chat Flow > Channels > Web Chat will now let users change specific values of text fields of their web chats and widgets, adding more variety to messages."><figcaption><p>The "Other Options" menu under Chat Flow > Channels > Web Chat will now let users change specific values of text fields of their web chats and widgets, adding more variety to messages.</p></figcaption></figure>

We've incorporated **Other Options** in Configure Web Chat, giving you the opportunity to provide specific string values to other parts of your AI Chatbot's web chats or web widgets.&#x20;

Unlike values such as your AI Chatbot's name or organization name, Other Options can let you customize more UI-leaning elements, specifically what your Web Chat says when...&#x20;

* ...you want to download the transcript
* ...it tells the date "today"
* ...you want to chat with a Live Agent
* ...you want to send a message to your Web Chat
* ...you want to start a conversation

And many more!

### 🆕 Speech Options make Web Chats more convenient!

<figure><img src="/files/QYyAFgXHS4919inWtFpS" alt="&#x22;Speech Options&#x22; in Chat Flows > Channel > Configure Web Chat will allow users to toggle options that will let them talk to AI Chatbots via their microphone (Enable Voice In) and/or hear spoken responses (Enable Read Out)."><figcaption><p>"Speech Options" in Chat Flows > Channel > Configure Web Chat will allow users to toggle options that will let them talk to AI Chatbots via their microphone (Enable Voice In) and/or hear spoken responses (Enable Read Out).</p></figcaption></figure>

Thanks to **Speech Options** within Configure Web Chat, we can now toggle more advanced and accessible audio options when interacting with our AI Chatbots. Depending on your preference, you can:

* **Enable Voice In:** This will let users use their microphone to talk to your AI Chatbot.
* **Enable Read Out:** This will let users get their AI Chatbot's responses in audio form.

### 🆕 Last Chat Message in Transcripts

<figure><img src="/files/7wMtEZ4bHdApDsbPxXHE" alt="&#x22;Last Chat Message&#x22; replaces &#x22;Name&#x22; in Transcripts, allowing users to see the last chat message sent before being logged into the Transcript for that specific time period."><figcaption><p>"Last Chat Message" replaces "Name" in Transcripts, allowing users to see the last chat message sent before being logged into the Transcript for that specific time period.</p></figcaption></figure>

We've removed the "Name" column in Transcripts and replaced them with **Last Chat Message**, giving you the last message sent to the conversation before it was logged by the system.&#x20;

### 🆕 Filter Options now available in Import Your Own Information

<figure><img src="/files/YSo1bB3egc3Po0x3qmtI" alt=""><figcaption><p>AI Chatbots > Add Data will bring users to an updated Import Your Own Information page, where there's a Filter for Status (Active/Other States) and Type (Web/PDF) as well as the option to sort things in ascending and descending order.</p></figcaption></figure>

Users can now filter and sort their data more efficiently in the "Import Your Own Information" page. New options include:

* **Filter:** Only reveal data based on their **Status (Active or Other Statuses)** and/or their **Type (Web or PDF)**
* **Sort:** Select arrows beside the name of the column you want to sort in descending or ascending order.

***

## v3.5.1

### 📆2025-02-10

### ✅ Added

* **Custom Channels are here!** If you want to integrate Captivate Chat functionalities into your own Channel outside our offerings, you can finally do so!
* **Citations are now live!** You can make your AI Chatbot provide sources of its data whenever it provides responses to users.
* **Token Estimation errors** are now reported! The platform will now let you know if a URL you plan on ingesting isn't available for processing.&#x20;
* **Asynchronous messages** are now saved in Transcripts. Messages that are via the Chatbot directly from agents (without using the Chat Flow) are now stored alongside traditional messages.
* **Session Expiry** can now be set in select Channels. This will end inactive chats after a set number of days.

### 🟧 Changed

* Changed a button in the Edit Data section of the Create AI Chatbot process.&#x20;

### ⚠️ Fixed

* **Smileys are back!** We fixed a chat error regarding emojis, so now you can add emojis to your conversations with AI Chatbots!
* Fixed a bug where pages are forcibly refreshed after the user uploads a file of the same file name multiple times during the Web Widget Test.
* Fixed a delay between the time users choose files to ingest and the system starts ingesting it.
* Fixed a bug that delays the Add Information section of the Create AI Chatbot process after an ingestion procedure is cancelled.
* Fixed a bug that doubles the URLs ingested when using the Captivate Chat URL Crawler.&#x20;

### 🆕 Custom Channels

<figure><img src="/files/MfMcBepmplBVpnrsABDi" alt="Select &#x22;Custom Channel&#x22; under Chat Flows > Channel in order to show your AI Chatbot in your very own Channel of choice outside our regular options. "><figcaption><p>Select "Custom Channel" under Chat Flows > Channel in order to show your AI Chatbot in your very own Channel of choice outside our regular options. </p></figcaption></figure>

**Custom Channels** are now available as a Channel option for Captivate Chat users. Select this if you want to show our AI Chatbot and connect your users to Live Agents in a different platform outside of our offerings.

This will require some manual setup, which we will provide in our guide!

### 🆕 Citations

<figure><img src="/files/IKE2UGKxOKYMCSjrTmhK" alt="In the &#x22;Import Your Own Information&#x22; window, you can toggle &#x22;Enable Citations&#x22; so your AI Chatbot will send an extra message after each response that contains the sources of its answers."><figcaption><p>In the "Import Your Own Information" window, you can toggle "Enable Citations" so your AI Chatbot will send an extra message after each response that contains the sources of its answers.</p></figcaption></figure>

**Citations** are now available in your Captivate Chat bots! This takes the form of a simple but powerful toggle in *AI Chatbots > Add Information.*&#x20;

If you turn on this toggle, your AI Chatbot will provide an extra response that contains the sources of their answers.

### 🆕 Token Estimation Errors

<figure><img src="/files/uVB0S3Rwo7ZYTiAROEYB" alt="Faulty URLs will now be flagged during the Token Estimation process of the AI Chatbot > Add Information part of the AI Chatbot Creation process.  "><figcaption><p>Faulty URLs will now be flagged during the Token Estimation process of the AI Chatbot > Add Information part of the AI Chatbot Creation process.  </p></figcaption></figure>

We now have **Token Estimation Errors** that will appear as error messages when trying to ingest faulty URLs.&#x20;

These errors will come with tooltips that explain why these URLs haven't been ingested, which range from inaccessible URLs to incompatible formats.

### 🆕 Session Expiry

<figure><img src="/files/RoDQyyFtfiH01gmHDU8B" alt="When editing Channels, you can change the &#x22;Session Timeout (Days)&#x22; of Instagram, Facebook Messenger, and WhatsApp. This will dictate the number of days before an existing inactive conversation is closed."><figcaption><p>When editing Channels, you can change the "Session Timeout (Days)" of Instagram, Facebook Messenger, and WhatsApp. This will dictate the number of days before an existing inactive conversation is closed.</p></figcaption></figure>

**Session Expiry** can now be modified in your Channels. This dictates the number of days before an existing (but inactive) conversation with your AI Chatbot on Instagram, Facebook Messenger, or WhatsApp is closed.

***

## v3.5.0

### 📆2025-01-29

### ✅ Added

* We now support **SCA Stripe**. SCA, which stands for Strong Customer Authentication, allows us to offer more secure transactions when purchasing Captivate Chat Tokens or upgrading your subscriptions.
* **Web Widgets:**
  * **Full Screen Embeds** are now available for Web Widget Chat Flows! Simply customize a special iframe code with your Web Widget's API and put that into the HTML of the webpage where you want a full screen AI Chatbot to greet your customers.&#x20;
* **Metadata:**
  * Will now have **conversation dates** added by default, helping you keep track of important information much faster.
  * Initial metadata will be stored in custom metadata, making data retrieval more efficient.
* **Captivate AI & LLM API** will now make it easier for AI devs to integrate with AIs with Captivate Chat.
* **Custom Channels:**
  * **New APIs** are available to make conversation deletions in the index (not the real sessions) much easier to manage if you're using our **Custom Channels:**
    * Use the `conversation_id` of that specific conversation to delete it from the index.
    * Use the `user_id` of the user in question to delete all their conversations from the index.
    * Asyncrhonous messaging via `send_message` can now handle file attachments.

### 🟧 Changed

* **Free and Basic Accounts** now get **1,000,000 Tokens!** This leaves you more room to try Captivate Chat for your projects.&#x20;
* **AI Chatbots:**
  * Clicking any AI Chatbot will immediately reveal the list of modifications you can do to them.

### ⚠️ Fixed

* Fixed some UI inconsistencies to provide a more seamless experience.&#x20;
* Fixed deep crawler issues, so it now:
  * Shows results in the estimator (instead of no results).&#x20;
  * Is not case sensitive (it was previously)
  * It doesn't need "[www](http://www)." (it previously did)
* Fixed issues involving the ingestion of at least 100 URLs.&#x20;
* Fixed issues involving the creation of an AI Chatbot directly from the Chat Flow process.

### 🆕 Captivate AI & LLM API

<figure><img src="/files/MC4qT7pQxCyS9qOqFWo5" alt="This is a Python Package Index (PyPI) screenshot of the Captivate AI &#x26; LLM API, an API developed by Captivate Chat to handle its API formats."><figcaption><p>This is a Python Package Index (PyPI) screenshot of the Captivate AI &#x26; LLM API, an API developed by Captivate Chat to handle its API formats.</p></figcaption></figure>

We have released the **Captivate AI & LLM API.** Access it [here](https://pypi.org/project/captivate-ai-api/).&#x20;

We developed the Captivate AI & LLM API to handle Captivate Chat's API formats. This flexible messaging and metadata management system is built using Pydantic models and designed to handle complex communication scenarios with robust checking and validation.

Its main features include dynamic metadata handling, immutable session and chat properties, flexible message type support, custom metadata manipulation, and conversation title management. &#x20;

### 🆕 Full Screen Embed Code

<figure><img src="/files/SdumJvBiMlW9PnPRbZ1C" alt="A Web Widget adjusted to fit a full screen resolution thanks to the Full Screen Embed Code. If you fill up a special iframe code with your Web Widget API and paste that code into the HTML of your assigned webpage, that particular webpage becomes a full-screen AI Chatbot."><figcaption><p>A Web Widget adjusted to fit a full screen resolution thanks to the Full Screen Embed Code. If you fill up a special iframe code with your Web Widget API and paste that code into the HTML of your assigned webpage, that particular webpage becomes a full-screen AI Chatbot.</p></figcaption></figure>

We have made a **Full Screen Embed Code** for you to use with your Web Widget Chat Flows!

Unlike our traditional embeds that provide you with an interactive AI Chatbot within a webpage, our Full Screen Embed Code will "fill" the webpage with your AI Chatbot. In order to do this, simply put your Web Widget API into a special iframe code you can access in [Channel: Web Chat](/start-creating/create-a-chat-flow/select-channel/channel-web-chat)

***

## v3.4.1

### 📆2025-01-10

### ✅ Added

* **AI Chatbots:**
  * **Select Type** now has a toggle for **Full Chat History**, letting you decide if you want your AI Chatbot to respond based on previous conversations with the user or to treat every conversation as a completely new one.&#x20;
  * You can now set **session expiration timers** within an AI Chatbot so they can automatically end an inactive session after your specified period of time.

### 🆕 Full Chat History

<figure><img src="/files/oCLdZa6wR3ZeqyfNgcUE" alt="The &#x22;Use Full Chat History For AI Context&#x22; toggle in &#x22;Select Type&#x22; when creating your own AI Chatbot will determine if the specific AI Chatbot in question will use all prior conversations with the user as the contextual basis of the current session. Toggling yes will do so, and toggling no on Full Chat History will treat each session as a completely new one."><figcaption><p>The "Use Full Chat History For AI Context" toggle in "Select Type" of the AI Chatbot creation process. This will determine if the specific AI Chatbot in question will use all prior conversations with the user as the contextual basis of the current session. Toggling yes will do so, and toggling no on Full Chat History will treat each session as a completely new one.</p></figcaption></figure>

We've added a **Full Chat History** toggle in the "Select Type" page of the AI Chatbot creation process.&#x20;

Taking the form of the "Use Full Chat History for AI Context" button, this will toggle whether the AI Chatbot in question will use all prior sessions with the user as context for its current responses. Doing so will cost more tokens, but will provide maximum accuracy.

## v3.4.0

### 📆2025-01-03

### ✅ Added

* **Tutorials are live!** Learn the ropes in creating your AI Chatbots, Chat Flows, and Live Agent integrations within the Tutorial page of the Captivate Chat platform!
* **Meet our Guidebot!** We've deployed our Guidebot within the Captivate Chat platform! Once you log in to your account, you can ask our Guidebot for any advice as well as tips and tricks on how to best use Captivate Chat for your needs!
* **Mobile Optimization notice** appears when users to try to access Captivate Chat on mobile platforms.&#x20;
* **AI Chatbots:**
  * **URL Crawler** is now added under "Import Your Own Information" that auto-searches all URLs under a single URL. This will make importing groups of URLs under a "mother" URL much easier.&#x20;

### 🟧 Changed

* **Our Token Estimator now uses Server-Sent Events (SSEs)**. Thanks to SSEs, we should be experiencing faster and more efficient resource management. With SSEs, AI Chatbots should be able to ingest new information much faster.
* **Cost-Saving toggle for Chat Histories are available globally.** We will now provide a global toggle for users to choose if they want to view the full or AI-analyzed chat histories of their AI Chatbots.&#x20;
  * This is unlike in previous versions, where this toggle is placed inside each AI Chatbot.&#x20;
  * As per the previous version, the AI-analyzed chat histories will cost fewer tokens to produce.&#x20;

### 🆕 Tutorials

<figure><img src="/files/y9FUJT1aG5KoUtXuaLH2" alt="The &#x22;Tutorial&#x22; page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson."><figcaption><p>The "Tutorial" page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson.</p></figcaption></figure>

Learning about Captivate Chat has never been easier!

Get in-depth tutorials on how to use the Captivate Chat platform using our **Tutorials** page! We have Tutorials for most of our processes in the platform, and we'll constantly update these Tutorials whenever we have major releases.&#x20;

To access our Tutorials, simply click the ![The "Tutorials" button on the left side of the dashboard leads to the "Tutorial" page. The The "Tutorial" page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson.](/files/M8rVYKuGCI8A4aiXnewf) button on the left side of the Captivate Chat dashboard.

### 🆕 URL Crawler

<figure><img src="/files/hRtVyFEmqyyfJTA4Upgj" alt="The &#x22;Import Your Own Information&#x22; page of the AI Chatbot creation process now features a URL Crawler. This is accessed via pressing the &#x22;Import Button.&#x22; With this, users can now enter one URL and it will take the first layer of URLs sharing its section. "><figcaption><p>The "Import Your Own Information" page of the AI Chatbot creation process now features a URL Crawler. This is accessed via pressing the "Import Button." With this, users can now enter one URL and it will take the first layer of URLs sharing its section. </p></figcaption></figure>

We've added a **URL Crawler** to the "Import Your Own Information" page of the AI Chatbot creation process. Users can now choose to enter a URL and Captivate Chat will gather all relevant URLs of its similar section.

If you want to retrieve relevant URLs within a particular website layer, the URL Crawler can also be used with a **wildcard character or an asterisk (\*)**.&#x20;

### 🆕 Mobile Optimization Notice

<figure><img src="/files/GmzMiM5Hvl7ckqidemRc" alt="The Captivate Chat platform can be opened in mobile browsers but it&#x27;s not yet optimized for mobile devices. We&#x27;ve added a Mobile Optimization Notice to warn users that while they can proceed to the Captivate Chat platform, its functions might not work properly in their device."><figcaption><p>The Captivate Chat platform can be opened in mobile browsers but it's not yet optimized for mobile devices. We've added a Mobile Optimization Notice to warn users that while they can proceed to the Captivate Chat platform, its functions might not work properly in their device.</p></figcaption></figure>

We added a **Mobile Optimization Notice** for users trying to access our platform using their mobile devices.

As have yet to fully optimize the Captivate Chat platform for mobile users, this means many functions of the Captivate Chat platform might not work properly in mobile browsers. You can continue to use the platform normally via mobile by clicking "Continue to Site" when you see the Mobile Optimization Notice.

***

## v3.2.0

### 📆 2024-10-02

### ✅ Added

* **Token Metrics** are now revealed for major AI Chatbot uses such as ingesting information, training, and various conversations to aid payment tracking.
* **AI Chatbots** now have a limiter and organizer to maximize Token usage without overwhelming their systems. This should lessen situations of AI Chatbots randomly slowing down.&#x20;

### 🟧 Changed

* **Web Widget Preview:** The Web Widget Preview now has a more noticeable *Page Settings* button to access its features.
* **Import Your Own Information (AI Chatbots):** Pagination should now reveal ingested PDFs and URLs in sets of 10 for more efficient compilation and access to users.&#x20;

### ⚠️ Fixed

* Made minor adjustments to the UI to improve accessibility and encourage a more engaging experience.&#x20;
* Streamlined Token tracking so users are immediately notified if they have run out of Tokens.
* Ensured that **delete** information (URLs, PDFs, accounts) are permanently deleted as intended.&#x20;
* **Microsoft Teams:** Transcripts of the AI Chatbot's conversation with a user are now retained when their concern is escalated to a Live Chat agent in MS Teams.

### 🆕 Token Metrics

<figure><img src="/files/JrKGxr3JOGat3kg2qjBO" alt="Tokens are now tracked throughout Captivate Chat features. The main Token count is revealed on the left side of the dashboard at all times, giving users an idea how many Tokens they have consumed, when their next Monthly Usage Reset would be, and any Extra Tokens they possess."><figcaption><p>Tokens are now tracked throughout Captivate Chat features. The main Token count is revealed on the left side of the dashboard at all times, giving users an idea how many Tokens they have consumed, when their next Monthly Usage Reset would be, and any Extra Tokens they possess.</p></figcaption></figure>

The Captivate Chat platform will now show **token metrics** to keep track of your Tokens whenever you use them across various parts of the platform. These include:

* Ingesting data that are uploaded into the system.
* Conversations between users and the AI Chatbots they create.
* Testing and deploying AI Chatbots in various platforms.

These token metrics can aid in managing your Captivate Chat plan, as major AI functionalities of the platform rely heavily in Token usage.

In line with this new change, we are also going to **actively track** Token usage across the platform and notify users whenever they have to purchase more Tokens.&#x20;

### 🆕We revamped the Web Widget Preview

<figure><img src="/files/uwE6BTULiGwbN8aTz1Qm" alt="The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget is revamped with a more streamlined look."><figcaption><p>The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget is revamped with a more streamlined look.</p></figcaption></figure>

We've upgraded the look of our **Web Widget Preview**!&#x20;

You can now preview your Web Widget Chat Flow with a completely revamped background.

<figure><img src="/files/kgQgn2yxu6pyLtojnpBV" alt="The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget now has a more visible &#x22;Page Settings&#x22; button to edit the live preview."><figcaption><p>The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget now has a more visible "Page Settings" button to edit the live preview.</p></figcaption></figure>

The ![](/files/6GQj7AARBbkkIq5K7TWn) button is now more visible and accessible, making it much easier for users to modify their live preview setup.&#x20;

***

## v3.1.1

### 📆 2024-09-19

### ✅ Added

* **Makeover!** We've updated the Captivate Chat website to feature our new logos!
* **Edit AI Chatbots while making Chat Flows!** You can now directly modify your AI Chatbots while creating your Chat Flows.&#x20;

### 🟧 Changed

* **Transcripts** now feature a separate **Date Range** filter instead of the previous **By Date** sorting filter.&#x20;

### ⚠️ Fixed

* Fixed a bug that doesn't load the complete list of ingested content for some Chat Flows.
* **Chat Flow > Channel > Web Widget:** Fixed a typo. There is now an *"Embed Web Widget"* option instead of the previous *"Embed Live Chat"* option.

### 🆕 Website Makeover!

<figure><img src="/files/WSvrXR6CntBLWeW40Nur" alt="The new Captivate Chat website featuring its updated logo with a blue color palette. "><figcaption><p>The new Captivate Chat website featuring its updated logo with a blue color palette. </p></figcaption></figure>

We're giving the Captivate Chat website a major makeover!&#x20;

This new update features **new logos** we've prepared for Captivate Chat, now featuring a sleek blue color palette designed to evoke a more professional and relaxing atmosphere.&#x20;

### 🆕 Edit your AI Chatbots while making Chat Flows

<figure><img src="/files/73VxETu8V75vd19EW77k" alt="Users can now click the three dots above their AI Chatbot choice in Setup > Chat Flow > My AI Chatbots to directly modify their AI Chatbots during the Chat Flow creation process."><figcaption><p>Users can now click the three dots above their AI Chatbot choice in Setup > Chat Flow > My AI Chatbots to directly modify their AI Chatbots during the Chat Flow creation process.</p></figcaption></figure>

We know that creating an AI Chatbot from scratch is wildly different when compared to connecting them to the rest of your Channels and Live Chats via a Chat Flow, as there are things you would only notice about your AI Chatbot after bringing everything together.

It's for this reason that we added a new feature that lets you **edit your AI Chatbots during the Chat Flow creation process**. After clicking *Setup > Chat Flow*, the list of AI Chatbots present in *My AI Chatbots* menu now feature a three dots that enable you to edit them straight in the Chat Flow-creation process.

This means you no longer have to go all the way back to *Setup > AI Chatbot* just to modify an AI Chatbot you'd use for your current Chat Flow - you can do everything in one convenient location.

***

## v3.0.0

### 📆 2024-09-18

### ✅ Added

* **Incident Tracker** now informs users whenever Captivate Chat services are down.
* **Overwrite Warning** will inform users that changing the Channel of an existing Chat Flow will remove their current setup.&#x20;

### 🟧 Changed

* **Transcripts** now feature various options to simplify their use, such as sorting and deletion options.

### ⚠️ Fixed

* AI Chatbots now properly recognizes postal codes of locations.
* AI Chatbots no longer declares in a separate chat message that they are checking for available Live Chat agents upon request, as we already have a preset message prepared when users ask to be escalated to a Live Chat agent.&#x20;
* **AI Chatbots > Select Type:** Removed a bug that triggers the *"Submit & Test"* function whenever users select a tooltip.&#x20;

### 🆕 Overwrite Warning (Chat Flow)

<figure><img src="/files/aL4bOjQh2BNuItZAoxZf" alt="Trying to change the Channel of an existing Chat Flow will now provide a warning to users that doing so will overwrite their existing data."><figcaption><p>Trying to change the Channel of an existing Chat Flow will now provide a warning to users that doing so will overwrite their existing data.</p></figcaption></figure>

We have included an **override warning** in Chat Flows that will activate whenever users try to change the Channel of an existing Chat Flow. Undergoing this process will overwrite their data, and any overwritten data can no longer be retrieved.

It's advisable for users to duplicate their existing Chat Flow before switching Channels, as doing so will force them to start creating their Chat Flow from scratch.&#x20;

### Transcript Options

<figure><img src="/files/rupksQ131JObx6NCTnki" alt="The Transcript page offers various features such as a Search function, as well as sorting through Filters such as Email, Channel, or Chat Flow. There are options to pick a Date to sort lists of conversations, as well as the option to check multiple conversations for deletion."><figcaption><p>The Transcript page offers various features such as a Search function, as well as sorting through Filters such as Email, Channel, or Chat Flow. There are options to pick a Date to sort lists of conversations, as well as the option to check multiple conversations for deletion.</p></figcaption></figure>

The **Transcript** page now offers different options for users to sort conversations detected by the Captivate Chat platform. These include the following:

* **Checkbox selection of conversations.** You can also mass-delete these conversations by pressing the ***Delete*** button, although this is irreversible.
* **Sort by various filters**, such as Date the conversation occurred, the Email used, Channel where the conversation took place, and the Chat Flow that managed the conversation.

***

## v2.2.0-2

### 📆2022-02-02

It's now much easier to use the Captivate Hub for your **Livechat** needs!&#x20;

We're introducing new ways to modify your Livechat to automate certain tasks. Thanks to **Manual Assignment**, you can now set pre-determined messages that trigger after specific conditions - such as assigning chats based on an agent's MS Teams status.&#x20;

Agents can also use the new ***`"Reassign"`*** command to transfer the chat to another available agent.&#x20;

### ✅ Added

* reCaptcha support on registration
  * Added new environmental variable on frontend `REACT_APP_GOOGLE_RECAPTCHA_KEY`
* Implementation of **Manual Assignment**
  * Added `manualAssign (bool)` `manualMessageUsersExist(string)` `manualMessageUsersNotExist (string)` `idleTimeoutBeforeAssign(int) (in minute)` `idleTimeoutAfterAssign(int) (in minute)` `idleMessageBeforeTimeout (string)` `idleMessageAfterTimeout (string)` to Hub properties.
* Implementation of **Agent Status**
  * Added `agentStatus (Array) [Available,Busy,Away,Offline]` to Hub properties.
* Implementation of **Reassign Agents**
* New React frontend
  * Added `GOOGLE_SECRET_KEY` to enviromental variable on chatbot
* **Livechat** configuration editor on frontend
* New Teams app permissions
  * `Site.Read.All` (for accessing files to teams and send it to channels)
  * `Group.ReadWrite.All` (for modifying teams channel permissions)

### 🟧 Changed

* All messages on channels to MS Teams is now tagged to selected agent

### 🟥 Removed

* Removed support for the legacy frontend. preferred the new React frontend

### ⚠️ Fixed

* Emojis and attachment message filter on agents' message
* Messages on direct mode is now properly sent to Teams Desktop and Teams Mobile

### 🆕 Agent Status (Livechat)

You can now **modify agent assignments** based on their **presence status** in MS Teams.&#x20;

Using the Livechat configuration, you can **set chat assignments** based on an agent's **status** or availability in MS Teams. Commands can affect agents who set themselves as `"Available",` `"Busy",` `"Away"` and `"Offline."`&#x20;

This example video demonstrates a Livechat configured to only assign chats to someone set as `"Busy".` Check it out:&#x20;

{% embed url="<https://www.youtube.com/watch?v=gG1GO2aHJAs>" %}
Agent status demonstration
{% endembed %}

### 🆕 Manual Assignment (Livechats)

You can now **activate&#x20;*****Manual Assignments*** when configuring a Livechat.&#x20;

This allows **pre-made messages** to be sent after **meeting certain conditions**. Here are the properties you can modify:

* `manualMessageUsersExist(string)`&#x20;

  Displays a message **if there is an available agent** to respond to the client.
* `manualMessageUsersNotExist (string)`&#x20;

  Displays a message **if there are no agents available** to respond to the client.&#x20;
* `idleTimeoutBeforeAssign(int) (in minute)`&#x20;

  A value **(in minutes)** before a timeout is declared, **should a conversation not be escalated** to an agent.&#x20;
* `idleTimeoutAfterAssign(int) (in minute)`&#x20;

  A value **(in minutes)** before a timeout is declared, **if there's an agent assigned but neither agent nor client is responding** to each other.
* `idleMessageBeforeTimeout (string)`&#x20;

  Displays a message when `idleTimeoutBeforeAssign(int)` elapses.
* `idleMessageAfterTimeout (string)`&#x20;

  Display a message when \`\`idleTimeoutAfterAssign(int)\` elapses.&#x20;

#### ➦ Default Values

Here are the **default Manual Assignment** values:&#x20;

* `manualAssign (bool):` false
* `manualMessageUsersExist(string):` “Our agents know you’re waiting and will chat here as soon as they’re free.”
* `manualMessageUsersNotExist (string):` “Our agents is currently busy at the moment.”
* `idleTimeoutBeforeAssign(int) (in minute):` 5
* `idleTimeoutAfterAssign(int) (in minute):` 10
* `idleMessageBeforeTimeout (string):` “Our agents is currently busy at the moment.”
* `idleMessageAfterTimeout (string):` “Livechat Ended”

#### ➦ Example Scenarios

You might find this manual assignment feature useful if you encounter the following scenarios:&#x20;

* **There are available users.**\
  Displays: **manualMessageUsersExist(string)**

  \
  Suppose Teams Group A is connected to the Captivate Hub web widget, and the channel is asking if there are any agents available. Agent A (Busy) and Agent B (Available) are currently online.\
  \
  If Manual Assignment exists that assigns a chat to anyone set as "Available" (Agent B), then the channel has to declare that there's at least one agent (Agent B) that might be available to assist them. <br>
* **There are no available users.**\
  Displays: **manualMessageUsersNotExist(string)** \
  \
  Suppose Teams Group A has an active channel asking if there are agents available. However, both Agent A (Busy) and Agent B (Busy) are both occupied. \
  \
  If only "Available" agents are programmed to receive chat assignments, then the channel declares there are no available agents to assist them. <br>
* **Time has elapsed and no users managed to assist them.**\
  Runs: **idleTimeoutBeforeAssign**\
  Displays: **idleMessageBeforeTimeout**\
  \
  Suppose Teams Group A has an active channel asking for agents, and Agent B (Available) is not busy. This will have the channel declare that an agent will assist the client soon. Until such a time that Agent B responds to the client, the chatbot will run the Idle Timeout counter. \
  \
  If the assigned time elapses and Agent B hasn't responded, a message explains that chat will be put on time out due to the lack of agent response. <br>
* **Time has elapsed that the agent and client didn't speak to each other.**\
  Runs: **idleTimeoutAfterAssign**\
  Displays: **idleMessageAfterTimeout**\
  \
  Suppose Teams Group A has an active channel asking for agents, and Agent B (Available) managed to respond to the client's questions. After some time, someone in the conversation hasn't responded. This triggers a background Idle Timeout counter.\
  \
  If the assigned time elapses, a message appears that states one of the parties have yet to respond and the chat will be put on time out.&#x20;

{% embed url="<https://www.youtube.com/watch?v=4p1kpHahDmk>" %}
Manual Assignment Demo
{% endembed %}

### 🆕 Reassign Agent

You can now use the ***`"Reassign"`*** command to **reassign agents within the same Teams group.**&#x20;

Normally, a Support Chatbot is assigned to an available Live Support Agent so they can answer client queries on their behalf. However, not all Live Support Agents can answer a client's questions. This is where ***Reassign*** comes in.&#x20;

Should the need arise to transfer control of the Support Chatbot to another Live Support Agent, do this **in the MS Teams chat:**

1. Type ***`"@TheCaptivateHub"`*** to tag the Captivate Hub
2. Type ***`"Reassign"`*** and press *Enter*.
3. An automated message will appear alongside a drop down of available team members.
4. Select the desired team member to transfer the Support Chatbot.

Check out the video below:

{% embed url="<https://www.youtube.com/watch?v=l1JoTW5_ZG8>" %}
Reassign agent demo
{% endembed %}

***

## v2.2.0-1

### 📆2021-08-26

**Instagram support is now live!**&#x20;

You can now use Captivate Hub to create chatbots for Instagram via the Watson Assistant. Before you create your Instagram chatbots, make sure your Instagram account is a Business Account and that it is connected to your Facebook Page.&#x20;

We made updates to the documentation to reflect these new changes.

### ✅ Added

* **Instagram** support
* Add bot templates support on Watson Assistant
* New enviromental variable for app-ecb-frontend (frontend / legacy)
  * `REACT_APP_FACEBOOK_APPID` - Facebook Application ID
* New enviromental variable for app-chatbot (chatbot)
  * `FACEBOOK_APPID` - Facebook Application ID
  * `FACEBOOK_SECRET` - Facebook Application Secret Key
* New permissions added to Facebook Application
  * `instagram_manage_messages`
  * `instagram_basic`
  * `pages_manage_metadata`
  * `pages_show_list`

### 🟧 Changed

* Using Facebook OAuth to add Facebook / Instagram as channels (same as Twitter now)
* Enabled public registration
* Update Microsoft Teams permissions for AppSource (<https://appsource.microsoft.com/en-us/product/office/WA200003575?tab=DetailsAndSupport>)

### 🆕 Instagram Integrations

Before attempting integrations, please ensure that you're using an **Instagram Business Account**. This account has to be **connected to your Facebook page**. For more information, please click [here](https://www.facebook.com/business/help/898752960195806).

#### ➦ Facebook Developers Advance Access

* public\_profile
* pages\_messaging
* Business Asset User Profile Access
* instagram\_manage\_messages
* instagram\_basic
* pages\_manage\_metadata
* pages\_show\_list

#### ➦ Facebook Developers Valid OAuth Redirect URLs

* Your app-channel-gateway Public URL (ex: <https://hub.captivat.io/gateways/channel>)

#### ➦ Facebook Developers Allowed Domains for the JavaScript SDK

* Your frontend Public URL (ex: <https://hub.captivat.io/>)

To add Instagram to the Hub, you click the link below:

{% content-ref url="/pages/K3oA79KPLTUTTsJbnstn" %}
[Broken mention](broken://pages/K3oA79KPLTUTTsJbnstn)
{% endcontent-ref %}

### ⚠️ Teams Application Permission

* Channel.Create
* Channel.Delete.All
* Channel.ReadBasic.All
* ChannelMessage.Read.All
* Chat.ReadWrite
* Group.Read.All
* Presence.Read.All
* Team.Create
* Team.ReadBasic.All
* TeamMember.ReadWrite.All
* TeamActivity.Send
* TeamAppInstallation.TeadWrite
* User.ReadBasic.All

***

## v2.2.0

### 📆2021-08-06

This is the Initial release of the **Captivate Hub** to the public.

### ✅ Added

* Bot Template setup
* Registration

### 🟧 Changed

* Changed frontend (<https://hub.captivat.io>) to the new design
* Old frontend will be hosted on legacy.
* Moved <https://manual.captivat.io> to Gitbook


# Copy of Changelog

All changes to the Captivate Hub will be added here. Guides will be updated concurrently.

## 📆 v3.4.0 - 2025-01-03

### ✅ Added

* **Tutorials are live!** Learn the ropes in creating your AI Chatbots, Chat Flows, and Live Agent integrations within the Tutorial page of the Captivate Chat platform!
* **Meet our Guidebot!** We've deployed our Guidebot within the Captivate Chat platform! Once you log in to your account, you can ask our Guidebot for any advice as well as tips and tricks on how to best use Captivate Chat for your needs!
* We now support **SCA Stripe**. SCA, which stands for Strong Customer Authentication, allows us to offer more secure transactions when purchasing Captivate Chat Tokens or upgrading your subscriptions.
* **Mobile Optimization notice** appears when users to try to access Captivate Chat on mobile platforms.&#x20;
* **AI Chatbots:**
  * **Select Integrations** within AI Chatbots are now fully functional. User emails and names will be sent to the platforms you integrated into the AI Chatbot during the AI Chatbot Creation and AI Chatbot Update processes.
  * **URL Crawler** is now added under "Import Your Own Information" that auto-searches all URLs under a single URL. This will make importing groups of URLs under a "mother" URL much easier.&#x20;
  * You can now set **session expiration timers** within an AI Chatbot so they can automatically end an inactive session after your specified period of time.

### 🟧 Changed

* **Our Token Estimator now uses Server-Sent Events (SSEs)**. Thanks to SSEs, we should be experiencing faster and more efficient resource management. With SSEs, AI Chatbots should be able to ingest new information much faster.
* **Cost-Saving toggle for Chat Histories are available globally.** We will now provide a global toggle for users to choose if they want to view the full or AI-analyzed chat histories of their AI Chatbots.&#x20;
  * This is unlike in previous versions, where this toggle is placed inside each AI Chatbot.&#x20;
  * As per the previous version, the AI-analyzed chat histories will cost fewer tokens to produce.&#x20;

### 🆕 Tutorials

<figure><img src="/files/y9FUJT1aG5KoUtXuaLH2" alt="The &#x22;Tutorial&#x22; page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson."><figcaption><p>The "Tutorial" page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson.</p></figcaption></figure>

Learning about Captivate Chat has never been easier!

Get in-depth tutorials on how to use the Captivate Chat platform using our **Tutorials** page! We have Tutorials for most of our processes in the platform, and we'll constantly update these Tutorials whenever we have major releases.&#x20;

To access our Tutorials, simply click the ![The "Tutorials" button on the left side of the dashboard leads to the "Tutorial" page. The The "Tutorial" page in the Captivate Chat platform contain videos that explain essential processes in using Captivate Chat. They are arranged in tiles, with a thumbnail and the name of the lesson.](/files/M8rVYKuGCI8A4aiXnewf) button on the left side of the Captivate Chat dashboard.

### 🆕 Select Integration

<figure><img src="/files/bSpoFTwHRFELFuoyZ3JZ" alt="The &#x22;Select Integration&#x22; page of the AI Chatbot creation process will let users choose what platform they want to use to receive data from AI Chatbots. This integration will store the emails and names of users that ask an AI Chatbot to connect them to a Live Agent."><figcaption><p>The "Select Integration" page of the AI Chatbot creation process will let users choose what platform they want to use to receive data from AI Chatbots. This integration will store the emails and names of users that ask an AI Chatbot to connect them to a Live Agent.</p></figcaption></figure>

The **Select Integration** page of the AI Chatbot creation process is now live. Users can use this page to customize where their AI Chatbots will send customer data whenever they ask AI Chatbots to connect them to Live Agents.&#x20;

We currently offer HubSpot, Email, and Google Sheets as our integration platforms. As of now, we can only collect a user's name and email address.&#x20;

### 🆕 URL Crawler

<figure><img src="/files/hRtVyFEmqyyfJTA4Upgj" alt="The &#x22;Import Your Own Information&#x22; page of the AI Chatbot creation process now features a URL Crawler. This is accessed via pressing the &#x22;Import Button.&#x22; With this, users can now enter one URL and it will take the first layer of URLs sharing its section. "><figcaption><p>The "Import Your Own Information" page of the AI Chatbot creation process now features a URL Crawler. This is accessed via pressing the "Import Button." With this, users can now enter one URL and it will take the first layer of URLs sharing its section. </p></figcaption></figure>

We've added a **URL Crawler** to the "Import Your Own Information" page of the AI Chatbot creation process. Users can now choose to enter a URL and Captivate Chat will gather all relevant URLs of its similar section.

If you want to retrieve relevant URLs within a particular website layer, the URL Crawler can also be used with a **wildcard character or an asterisk (\*)**.&#x20;

### 🆕 Mobile Optimization Notice

<figure><img src="/files/GmzMiM5Hvl7ckqidemRc" alt="The Captivate Chat platform can be opened in mobile browsers but it&#x27;s not yet optimized for mobile devices. We&#x27;ve added a Mobile Optimization Notice to warn users that while they can proceed to the Captivate Chat platform, its functions might not work properly in their device."><figcaption><p>The Captivate Chat platform can be opened in mobile browsers but it's not yet optimized for mobile devices. We've added a Mobile Optimization Notice to warn users that while they can proceed to the Captivate Chat platform, its functions might not work properly in their device.</p></figcaption></figure>

We added a **Mobile Optimization Notice** for users trying to access our platform using their mobile devices.

As have yet to fully optimize the Captivate Chat platform for mobile users, this means many functions of the Captivate Chat platform might not work properly in mobile browsers. You can continue to use the platform normally via mobile by clicking "Continue to Site" when you see the Mobile Optimization Notice.

***

## 📆 v3.2.0 - 2024-10-02

### ✅ Added

* **Token Metrics** are now revealed for major AI Chatbot uses such as ingesting information, training, and various conversations to aid payment tracking.
* **AI Chatbots** now have a limiter and organizer to maximize Token usage without overwhelming their systems. This should lessen situations of AI Chatbots randomly slowing down.&#x20;

### 🟧 Changed

* **Web Widget Preview:** The Web Widget Preview now has a more noticeable *Page Settings* button to access its features.
* **Import Your Own Information (AI Chatbots):** Pagination should now reveal ingested PDFs and URLs in sets of 10 for more efficient compilation and access to users.&#x20;

### ⚠️ Fixed

* Made minor adjustments to the UI to improve accessibility and encourage a more engaging experience.&#x20;
* Streamlined Token tracking so users are immediately notified if they have run out of Tokens.
* Ensured that **delete** information (URLs, PDFs, accounts) are permanently deleted as intended.&#x20;
* **Microsoft Teams:** Transcripts of the AI Chatbot's conversation with a user are now retained when their concern is escalated to a Live Chat agent in MS Teams.

### 🆕 Token Metrics

<figure><img src="/files/JrKGxr3JOGat3kg2qjBO" alt="Tokens are now tracked throughout Captivate Chat features. The main Token count is revealed on the left side of the dashboard at all times, giving users an idea how many Tokens they have consumed, when their next Monthly Usage Reset would be, and any Extra Tokens they possess."><figcaption><p>Tokens are now tracked throughout Captivate Chat features. The main Token count is revealed on the left side of the dashboard at all times, giving users an idea how many Tokens they have consumed, when their next Monthly Usage Reset would be, and any Extra Tokens they possess.</p></figcaption></figure>

The Captivate Chat platform will now show **token metrics** to keep track of your Tokens whenever you use them across various parts of the platform. These include:

* Ingesting data that are uploaded into the system.
* Conversations between users and the AI Chatbots they create.
* Testing and deploying AI Chatbots in various platforms.

These token metrics can aid in managing your Captivate Chat plan, as major AI functionalities of the platform rely heavily in Token usage.

In line with this new change, we are also going to **actively track** Token usage across the platform and notify users whenever they have to purchase more Tokens.&#x20;

### 🆕We revamped the Web Widget Preview

<figure><img src="/files/uwE6BTULiGwbN8aTz1Qm" alt="The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget is revamped with a more streamlined look."><figcaption><p>The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget is revamped with a more streamlined look.</p></figcaption></figure>

We've upgraded the look of our **Web Widget Preview**!&#x20;

You can now preview your Web Widget Chat Flow with a completely revamped background.

<figure><img src="/files/kgQgn2yxu6pyLtojnpBV" alt="The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget now has a more visible &#x22;Page Settings&#x22; button to edit the live preview."><figcaption><p>The Web Widget Preview of Setup > Chat Flow > Channels > Web Widget now has a more visible "Page Settings" button to edit the live preview.</p></figcaption></figure>

The ![](/files/6GQj7AARBbkkIq5K7TWn) button is now more visible and accessible, making it much easier for users to modify their live preview setup.&#x20;

***

## 📆 v3.1.1 - 2024-09-19

### ✅ Added

* **Makeover!** We've updated the Captivate Chat website to feature our new logos!
* **Edit AI Chatbots while making Chat Flows!** You can now directly modify your AI Chatbots while creating your Chat Flows.&#x20;

### 🟧 Changed

* **Transcripts** now feature a separate **Date Range** filter instead of the previous **By Date** sorting filter.&#x20;

### ⚠️ Fixed

* Fixed a bug that doesn't load the complete list of ingested content for some Chat Flows.
* **Chat Flow > Channel > Web Widget:** Fixed a typo. There is now an *"Embed Web Widget"* option instead of the previous *"Embed Live Chat"* option.

### 🆕 Website Makeover!

<figure><img src="/files/WSvrXR6CntBLWeW40Nur" alt="The new Captivate Chat website featuring its updated logo with a blue color palette. "><figcaption><p>The new Captivate Chat website featuring its updated logo with a blue color palette. </p></figcaption></figure>

We're giving the Captivate Chat website a major makeover!&#x20;

This new update features **new logos** we've prepared for Captivate Chat, now featuring a sleek blue color palette designed to evoke a more professional and relaxing atmosphere.&#x20;

### 🆕 Edit your AI Chatbots while making Chat Flows

<figure><img src="/files/73VxETu8V75vd19EW77k" alt="Users can now click the three dots above their AI Chatbot choice in Setup > Chat Flow > My AI Chatbots to directly modify their AI Chatbots during the Chat Flow creation process."><figcaption><p>Users can now click the three dots above their AI Chatbot choice in Setup > Chat Flow > My AI Chatbots to directly modify their AI Chatbots during the Chat Flow creation process.</p></figcaption></figure>

We know that creating an AI Chatbot from scratch is wildly different when compared to connecting them to the rest of your Channels and Live Chats via a Chat Flow, as there are things you would only notice about your AI Chatbot after bringing everything together.

It's for this reason that we added a new feature that lets you **edit your AI Chatbots during the Chat Flow creation process**. After clicking *Setup > Chat Flow*, the list of AI Chatbots present in *My AI Chatbots* menu now feature a three dots that enable you to edit them straight in the Chat Flow-creation process.

This means you no longer have to go all the way back to *Setup > AI Chatbot* just to modify an AI Chatbot you'd use for your current Chat Flow - you can do everything in one convenient location.

***

## 📆 v3.0.0 - 2024-09-18

### ✅ Added

* **Incident Tracker** now informs users whenever Captivate Chat services are down.
* **Overwrite Warning** will inform users that changing the Channel of an existing Chat Flow will remove their current setup.&#x20;

### 🟧 Changed

* **Transcripts** now feature various options to simplify their use, such as sorting and deletion options.

### ⚠️ Fixed

* AI Chatbots now properly recognizes postal codes of locations.
* AI Chatbots no longer declares in a separate chat message that they are checking for available Live Chat agents upon request, as we already have a preset message prepared when users ask to be escalated to a Live Chat agent.&#x20;
* **AI Chatbots > Select Type:** Removed a bug that triggers the *"Submit & Test"* function whenever users select a tooltip.&#x20;

### 🆕 Overwrite Warning (Chat Flow)

<figure><img src="/files/aL4bOjQh2BNuItZAoxZf" alt="Trying to change the Channel of an existing Chat Flow will now provide a warning to users that doing so will overwrite their existing data."><figcaption><p>Trying to change the Channel of an existing Chat Flow will now provide a warning to users that doing so will overwrite their existing data.</p></figcaption></figure>

We have included an **override warning** in Chat Flows that will activate whenever users try to change the Channel of an existing Chat Flow. Undergoing this process will overwrite their data, and any overwritten data can no longer be retrieved.

It's advisable for users to duplicate their existing Chat Flow before switching Channels, as doing so will force them to start creating their Chat Flow from scratch.&#x20;

### Transcript Options

<figure><img src="/files/rupksQ131JObx6NCTnki" alt="The Transcript page offers various features such as a Search function, as well as sorting through Filters such as Email, Channel, or Chat Flow. There are options to pick a Date to sort lists of conversations, as well as the option to check multiple conversations for deletion."><figcaption><p>The Transcript page offers various features such as a Search function, as well as sorting through Filters such as Email, Channel, or Chat Flow. There are options to pick a Date to sort lists of conversations, as well as the option to check multiple conversations for deletion.</p></figcaption></figure>

The **Transcript** page now offers different options for users to sort conversations detected by the Captivate Chat platform. These include the following:

* **Checkbox selection of conversations.** You can also mass-delete these conversations by pressing the ***Delete*** button, although this is irreversible.
* **Sort by various filters**, such as Date the conversation occurred, the Email used, Channel where the conversation took place, and the Chat Flow that managed the conversation.

***

## 📆 v2.2.0-2 - 2022-02-02

It's now much easier to use the Captivate Hub for your **Livechat** needs!&#x20;

We're introducing new ways to modify your Livechat to automate certain tasks. Thanks to **Manual Assignment**, you can now set pre-determined messages that trigger after specific conditions - such as assigning chats based on an agent's MS Teams status.&#x20;

Agents can also use the new ***`"Reassign"`*** command to transfer the chat to another available agent.&#x20;

### ✅ Added

* reCaptcha support on registration
  * Added new environmental variable on frontend `REACT_APP_GOOGLE_RECAPTCHA_KEY`
* Implementation of **Manual Assignment**
  * Added `manualAssign (bool)` `manualMessageUsersExist(string)` `manualMessageUsersNotExist (string)` `idleTimeoutBeforeAssign(int) (in minute)` `idleTimeoutAfterAssign(int) (in minute)` `idleMessageBeforeTimeout (string)` `idleMessageAfterTimeout (string)` to Hub properties.
* Implementation of **Agent Status**
  * Added `agentStatus (Array) [Available,Busy,Away,Offline]` to Hub properties.
* Implementation of **Reassign Agents**
* New React frontend
  * Added `GOOGLE_SECRET_KEY` to enviromental variable on chatbot
* **Livechat** configuration editor on frontend
* New Teams app permissions
  * `Site.Read.All` (for accessing files to teams and send it to channels)
  * `Group.ReadWrite.All` (for modifying teams channel permissions)

### 🟧 Changed

* All messages on channels to MS Teams is now tagged to selected agent

### 🟥 Removed

* Removed support for the legacy frontend. preferred the new React frontend

### ⚠️ Fixed

* Emojis and attachment message filter on agents' message
* Messages on direct mode is now properly sent to Teams Desktop and Teams Mobile

### 🆕 Agent Status (Livechat)

You can now **modify agent assignments** based on their **presence status** in MS Teams.&#x20;

Using the Livechat configuration, you can **set chat assignments** based on an agent's **status** or availability in MS Teams. Commands can affect agents who set themselves as `"Available",` `"Busy",` `"Away"` and `"Offline."`&#x20;

This example video demonstrates a Livechat configured to only assign chats to someone set as `"Busy".` Check it out:&#x20;

{% embed url="<https://www.youtube.com/watch?v=gG1GO2aHJAs>" %}
Agent status demonstration
{% endembed %}

### 🆕 Manual Assignment (Livechats)

You can now **activate&#x20;*****Manual Assignments*** when configuring a Livechat.&#x20;

This allows **pre-made messages** to be sent after **meeting certain conditions**. Here are the properties you can modify:

* `manualMessageUsersExist(string)`&#x20;

  Displays a message **if there is an available agent** to respond to the client.
* `manualMessageUsersNotExist (string)`&#x20;

  Displays a message **if there are no agents available** to respond to the client.&#x20;
* `idleTimeoutBeforeAssign(int) (in minute)`&#x20;

  A value **(in minutes)** before a timeout is declared, **should a conversation not be escalated** to an agent.&#x20;
* `idleTimeoutAfterAssign(int) (in minute)`&#x20;

  A value **(in minutes)** before a timeout is declared, **if there's an agent assigned but neither agent nor client is responding** to each other.
* `idleMessageBeforeTimeout (string)`&#x20;

  Displays a message when `idleTimeoutBeforeAssign(int)` elapses.
* `idleMessageAfterTimeout (string)`&#x20;

  Display a message when \`\`idleTimeoutAfterAssign(int)\` elapses.&#x20;

#### ➦ Default Values

Here are the **default Manual Assignment** values:&#x20;

* `manualAssign (bool):` false
* `manualMessageUsersExist(string):` “Our agents know you’re waiting and will chat here as soon as they’re free.”
* `manualMessageUsersNotExist (string):` “Our agents is currently busy at the moment.”
* `idleTimeoutBeforeAssign(int) (in minute):` 5
* `idleTimeoutAfterAssign(int) (in minute):` 10
* `idleMessageBeforeTimeout (string):` “Our agents is currently busy at the moment.”
* `idleMessageAfterTimeout (string):` “Livechat Ended”

#### ➦ Example Scenarios

You might find this manual assignment feature useful if you encounter the following scenarios:&#x20;

* **There are available users.**\
  Displays: **manualMessageUsersExist(string)**

  \
  Suppose Teams Group A is connected to the Captivate Hub web widget, and the channel is asking if there are any agents available. Agent A (Busy) and Agent B (Available) are currently online.\
  \
  If Manual Assignment exists that assigns a chat to anyone set as "Available" (Agent B), then the channel has to declare that there's at least one agent (Agent B) that might be available to assist them. <br>
* **There are no available users.**\
  Displays: **manualMessageUsersNotExist(string)** \
  \
  Suppose Teams Group A has an active channel asking if there are agents available. However, both Agent A (Busy) and Agent B (Busy) are both occupied. \
  \
  If only "Available" agents are programmed to receive chat assignments, then the channel declares there are no available agents to assist them. <br>
* **Time has elapsed and no users managed to assist them.**\
  Runs: **idleTimeoutBeforeAssign**\
  Displays: **idleMessageBeforeTimeout**\
  \
  Suppose Teams Group A has an active channel asking for agents, and Agent B (Available) is not busy. This will have the channel declare that an agent will assist the client soon. Until such a time that Agent B responds to the client, the chatbot will run the Idle Timeout counter. \
  \
  If the assigned time elapses and Agent B hasn't responded, a message explains that chat will be put on time out due to the lack of agent response. <br>
* **Time has elapsed that the agent and client didn't speak to each other.**\
  Runs: **idleTimeoutAfterAssign**\
  Displays: **idleMessageAfterTimeout**\
  \
  Suppose Teams Group A has an active channel asking for agents, and Agent B (Available) managed to respond to the client's questions. After some time, someone in the conversation hasn't responded. This triggers a background Idle Timeout counter.\
  \
  If the assigned time elapses, a message appears that states one of the parties have yet to respond and the chat will be put on time out.&#x20;

{% embed url="<https://www.youtube.com/watch?v=4p1kpHahDmk>" %}
Manual Assignment Demo
{% endembed %}

### 🆕 Reassign Agent

You can now use the ***`"Reassign"`*** command to **reassign agents within the same Teams group.**&#x20;

Normally, a Support Chatbot is assigned to an available Live Support Agent so they can answer client queries on their behalf. However, not all Live Support Agents can answer a client's questions. This is where ***Reassign*** comes in.&#x20;

Should the need arise to transfer control of the Support Chatbot to another Live Support Agent, do this **in the MS Teams chat:**

1. Type ***`"@TheCaptivateHub"`*** to tag the Captivate Hub
2. Type ***`"Reassign"`*** and press *Enter*.
3. An automated message will appear alongside a drop down of available team members.
4. Select the desired team member to transfer the Support Chatbot.

Check out the video below:

{% embed url="<https://www.youtube.com/watch?v=l1JoTW5_ZG8>" %}
Reassign agent demo
{% endembed %}

***

## 📆 v2.2.0-1 - 2021-08-26

**Instagram support is now live!**&#x20;

You can now use Captivate Hub to create chatbots for Instagram via the Watson Assistant. Before you create your Instagram chatbots, make sure your Instagram account is a Business Account and that it is connected to your Facebook Page.&#x20;

We made updates to the documentation to reflect these new changes.

### ✅ Added

* **Instagram** support
* Add bot templates support on Watson Assistant
* New enviromental variable for app-ecb-frontend (frontend / legacy)
  * `REACT_APP_FACEBOOK_APPID` - Facebook Application ID
* New enviromental variable for app-chatbot (chatbot)
  * `FACEBOOK_APPID` - Facebook Application ID
  * `FACEBOOK_SECRET` - Facebook Application Secret Key
* New permissions added to Facebook Application
  * `instagram_manage_messages`
  * `instagram_basic`
  * `pages_manage_metadata`
  * `pages_show_list`

### 🟧 Changed

* Using Facebook OAuth to add Facebook / Instagram as channels (same as Twitter now)
* Enabled public registration
* Update Microsoft Teams permissions for AppSource (<https://appsource.microsoft.com/en-us/product/office/WA200003575?tab=DetailsAndSupport>)

### 🆕 Instagram Integrations

Before attempting integrations, please ensure that you're using an **Instagram Business Account**. This account has to be **connected to your Facebook page**. For more information, please click [here](https://www.facebook.com/business/help/898752960195806).

#### ➦ Facebook Developers Advance Access

* public\_profile
* pages\_messaging
* Business Asset User Profile Access
* instagram\_manage\_messages
* instagram\_basic
* pages\_manage\_metadata
* pages\_show\_list

#### ➦ Facebook Developers Valid OAuth Redirect URLs

* Your app-channel-gateway Public URL (ex: <https://hub.captivat.io/gateways/channel>)

#### ➦ Facebook Developers Allowed Domains for the JavaScript SDK

* Your frontend Public URL (ex: <https://hub.captivat.io/>)

To add Instagram to the Hub, you click the link below:

{% content-ref url="/pages/K3oA79KPLTUTTsJbnstn" %}
[Broken mention](broken://pages/K3oA79KPLTUTTsJbnstn)
{% endcontent-ref %}

### ⚠️ Teams Application Permission

* Channel.Create
* Channel.Delete.All
* Channel.ReadBasic.All
* ChannelMessage.Read.All
* Chat.ReadWrite
* Group.Read.All
* Presence.Read.All
* Team.Create
* Team.ReadBasic.All
* TeamMember.ReadWrite.All
* TeamActivity.Send
* TeamAppInstallation.TeadWrite
* User.ReadBasic.All

***

## 📆 v2.2.0 - 2021-08-26

This is the Initial release of the **Captivate Hub** to the public.

### ✅ Added

* Bot Template setup
* Registration

### 🟧 Changed

* Changed frontend (<https://hub.captivat.io>) to the new design
* Old frontend will be hosted on legacy.
* Moved <https://manual.captivat.io> to Gitbook


# Get Started

You've learned about the Captivate platform - yay! Now what?

If you want to start creating your Athenas, AI Chatbots and Chat Flows, please do the following:

1. **Register** and create a user account using [this link](https://app.captivatechat.ai/auth/register).
2. **Login** with your Captivate account.

<figure><img src="/files/hw334g3JzLieiPkKwPiG" alt="The Captivate Chat login screen."><figcaption><p>The Captivate Chat login screen.</p></figcaption></figure>

## Need Assistance?

Feel free to contact the Captivate support team with any of your concerns! Let us know if you're confused about a certain process or want a custom-tailored Hub for your specific enterprise.


# Homepage

How do we navigate the Captivate Chat platform?

<figure><img src="/files/5DNadBkIQKf16gcQV23C" alt="The Captivate Chat homepage that contains the core features of the platform: AI Chatbots, Chat Flows, Reports, Transcripts, Tutorials, Tokens, User Subscription Plans, and User Settings."><figcaption><p>The Captivate Chat homepage that contains the core features of the platform: AI Chatbots, Chat Flows, Reports, Transcripts, Tutorials, Tokens, User Subscription Plans, and User Settings.</p></figcaption></figure>

**The Homepage** is the first thing you will see once you log into **Captivate Chat**. Everything you need to start creating your AI Chatbots. Chat Flows, and integrations can be accessed here.&#x20;

## Homepage Components

Access these functionalities on the left side of the Homepage:&#x20;

* **Setup:** Create the tools you need for your Chat Flows. It's divided into:
  * **AI Chatbots** for AI Chatbot creation, and
  * **Chat Flows** where you connect your AI Chatbots to Channels and Live Chat vendors
* **Transcripts:** Read chat logs between your Agents and AI Chatbots are stored for your reference.
* **Tutorials:** Watch guides on how to use Captivate Chat - from basic tips to advanced methodologies.&#x20;


# Setup

Locate your AI Chatbots and Chat Flows here

<figure><img src="/files/pDzEL1kiZSHU7rPpBrJU" alt="In the main Captivate homepage, you can access &#x22;AI Chatbots&#x22; and &#x22;Chat Flows&#x22; by clicking the &#x22;Setup&#x22; dropdown located in the left-side dashboard."><figcaption><p>In the main Captivate homepage, you can access "AI Chatbots" and "Chat Flows" by clicking the "Setup" dropdown located in the left-side dashboard.</p></figcaption></figure>

**Setup** is where the magic happens!&#x20;

Clicking the drop-down arrow will reveal the following components:

### AI Chatbots

Create and edit all your AI Chatbots in  ![The AI Chatbots button in the Homepage](/files/Ke2WQPp9TNe49kCxMS76).

### Chat Flows

Create and edit your Chat Flows in  ![The Chat Flows button in the Homepage](/files/8d3fBxgvx0bQ6j0VLuWm).&#x20;

***

Clicking either **AI Chatbots** or **Chat Flows** for the first time will reveal an empty tab. However, they will slowly get populated by AI Chatbots and Chat Flows as you use our platform.&#x20;

If you want to skip straight to creating your AI Chatbots and Chat Flows, you can check these guides:

{% content-ref url="/pages/qj0en0fKQZYaeiNnVhqE" %}
[Create an AI Chatbot](/start-creating/create-an-ai-chatbot)
{% endcontent-ref %}

{% content-ref url="/pages/TeFDhW0EXurIMO8BpHpV" %}
[Create a Chat Flow](/start-creating/create-a-chat-flow)
{% endcontent-ref %}


# My AI Chatbots

Design your AI Chatbots to perform specific tasks

<figure><img src="/files/fn3CQufYLc3mFigyXMlU" alt="Clicking Setup > AI Chatbots reveals the &#x22;My AI Chatbots&#x22; page. This contains the list of your AI Chatbots and is the best place to make one from scratch."><figcaption><p>Clicking Setup > AI Chatbots reveals the "My AI Chatbots" page. This contains the list of your AI Chatbots and is the best place to make one from scratch.</p></figcaption></figure>

Clicking ***Setup > AI Chatbots*** reveals the ***My AI Chatbots*** page. This view reveals a list of existing Chatbots you created under your account.&#x20;

The ***My AI Chatbots*** view has the following components:&#x20;

### +AI Chatbot

Click on ![The +AI Chatbot button in "My AI Chatbots" page can create a new Chatbot.](/files/8pOuGeyUW6frxKPFfgZJ) to add a new AI Chatbot.&#x20;

### AI Chatbot List

<figure><img src="/files/enc7mwyd9j1aQICecHDE" alt="A list of AI Chatbots containing a unique title and icon. The selected AI Chatbot is in dark blue."><figcaption><p>A list of AI Chatbots containing a unique title and icon. The selected AI Chatbot is in dark blue.</p></figcaption></figure>

Each AI Chatbot in your account is represented by an AI Chatbot Tile.&#x20;

***

## Create your AI Chatbot

You can create your AI Chatbot by following the process here:

{% content-ref url="/pages/qj0en0fKQZYaeiNnVhqE" %}
[Create an AI Chatbot](/start-creating/create-an-ai-chatbot)
{% endcontent-ref %}

***

## Modify your AI Chatbot

Selecting a tile allows you to modify it in a variety of ways.

<figure><img src="/files/3P74Q9aUMXQNMKlX9e49" alt="Clicking any AI Chatbot tile in the &#x22;My AI Chatbots&#x22; list reveals a set of options for modifications. This is also accessible via the ellipsis (...) on the upper-right of the tile."><figcaption><p>Clicking any AI Chatbot tile in the "My AI Chatbots" list reveals a set of options for modifications. This is also accessible via the ellipsis (...) on the upper-right of the tile.</p></figcaption></figure>

You can modify and edit your AI Chatbot by following the instructions here:&#x20;

{% content-ref url="/pages/p9jSpaftKXdXC2ss3Mny" %}
[Modify your AI Chatbots](/start-creating/create-an-ai-chatbot/modify-your-ai-chatbots)
{% endcontent-ref %}


# Chat Flows

Create Chat Flows that integrate AI Assistants and Chatbots into a Channel

<figure><img src="/files/itF9Ljf5TrWiDhKluXl0" alt="Clicking Setup > Chat Flows reveals the &#x22;Chat Flows&#x22; page. This contains a list of your current Chat Flows and the button to make a new Chat Flow. "><figcaption><p>Clicking Setup > Chat Flows reveals the "Chat Flows" page. This contains a list of your current Chat Flows and the button to make a new Chat Flow. </p></figcaption></figure>

Clicking ***Setup > Chat Flows*** reveals ***Chat Flows***. This view reveals a list of existing Chat Flows you organized under your account.&#x20;

The ***Chat Flows*** view has the following components:

### +Chat Flow

Click ![The +Chat Flow button in "Chat Flows" will start the Chat Flow setup process.](/files/OFsIDtBVjzISqiUHBYwk) to add a new Chat Flow.&#x20;

### Chat Flow List

<figure><img src="/files/06KO34Wv8NnRyvcOLl9n" alt="The &#x22;Chat Flows&#x22; page lists the user&#x27;s current Chat Flows. The information here includes the Chat Flow Name, their AI Chatbot, their Channel and preview options, their Live Chat of choice, and if they are toggled active or inactive."><figcaption><p>The "Chat Flows" page lists the user's current Chat Flows. The information here includes the Chat Flow Name, their AI Chatbot, their Channel and preview options, their Live Chat of choice, and if they are toggled active or inactive.</p></figcaption></figure>

All Chat Flows you created are listed in the Chat Flows list. Clicking the checkbox or the settings of any entry will let you modify it in a variety of ways.

***

## Create your Chat Flow

You can create your Chat Flow by following the process here:

{% content-ref url="/pages/TeFDhW0EXurIMO8BpHpV" %}
[Create a Chat Flow](/start-creating/create-a-chat-flow)
{% endcontent-ref %}

***

## Modify your Chat Flow

Clicking the ellipsis (...) at the right-most side of your Chat Flow row will reveal basic modification options.

<figure><img src="/files/KgRyt793PSGmb45vmn2N" alt="Clicking the ellipsis (...) at the right-most side of your Chat Flow row will reveal basic modification options such as to Edit, Rename, and Delete it."><figcaption><p>Clicking the ellipsis (...) at the right-most side of your Chat Flow row will reveal basic modification options such as to Edit, Rename, and Delete it.</p></figcaption></figure>

You can modify and edit your Chat Flow by following the instructions here:&#x20;

{% content-ref url="/pages/0ja0WC47jQQ69KaFfikY" %}
[Modify your Chat Flow](/start-creating/create-a-chat-flow/modify-your-chat-flow)
{% endcontent-ref %}


# Transcripts

Check notable dialogue between Users, Agents, and AI Assistants

<figure><img src="/files/UTvu9mhrTqFBgLutpFYr" alt="The &#x22;Transcripts&#x22; view lists potentially useful and relevant conversations between users and a particular Chat Flow. The view reveals the Hub Name (refers to Chat Flow used), the Channel involved, the Last Message in the conversation, and the Date and Time the conversation took place."><figcaption><p>The "Transcripts" view lists potentially useful and relevant conversations between users and a particular Chat Flow. The view reveals the Hub Name (refers to Chat Flow used), the Channel involved, the Last Message in the conversation, and the Date and Time the conversation took place.</p></figcaption></figure>

The ***Transcripts*** page reveals captured dialogue between Users, Agents, and AI Chatbots.&#x20;

When people use the Chat Flows you create with Captivate Chat, useful dialogue is captured and stored within your account.&#x20;

You can review these in the **Transcripts** tab.

Each **transcript** listed in the *Transcripts* page are arranged based on the following components:

* **Hub Name:** This is the name of the Chat Flow where the intelligent dialogue occurred.
* **Name:** This is the User who interacted with the Channel.
* **Channels:** This is the Channel used in the interaction - either an automated AI Chatbot or an agent via Live Chat.
* **Last Message:** The last relevant message associated with the conversation.
* **Date and Time:** This refers to a date and time of a particular interaction between the Chat Flow (AI Chatbot inside a Channel) and the user.

{% hint style="info" %}
**What kinds of dialogue are captured?**

Dialogue in the transcripts are stored within the *Transcripts* page whenever your AI Chatbot encounters a unique conversation after the user accesses its Chat Flow. This can come in different forms, some examples of which are:

* A user asking intelligent questions that challenged the AI Chatbot's knowledge
* A user providing new information that the AI Chatbot might deem useful in the future
* A user requesting for information or actions that are not available in the AI Chatbot's programming
* A user demonstrating different emotions throughout the exchange
  {% endhint %}

***

## Sorting Transcripts

<figure><img src="/files/BDr2gSKfNNGEdpnjznxa" alt="You have the option to sort Transcripts according to email, Channel variant, and Chat Flow type using the &#x22;Sort by&#x22; button beside &#x22;Clear Filters&#x22; in the Transcript toolbar. "><figcaption><p>The "Sort by" button lets users sort Transcripts according to Email, Channel, and Chat Flow</p></figcaption></figure>

You have the option to sort Transcripts according to email, Channel variant, and Chat Flow type using the **"Sort by"** button beside **"Clear Filters"** in the Transcript toolbar.&#x20;

<figure><img src="/files/Cdnz3EQDEdw4XkgGKeR0" alt="&#x22;Pick a date&#x22; button in the Transcript toolbar lets users sort Transcripts according to date. "><figcaption><p>"Pick a date" button in the Transcript toolbar lets users sort Transcripts according to date.</p></figcaption></figure>

You can also sort Transcripts according to date using the **"Pick a date"** button sorter in the Transcript toolbar.

***

## Clicking a Transcript

<figure><img src="/files/8ad13WKnTS0UoE50j0rD" alt=""><figcaption><p>The Conversation View reveals information about the Chat Flow used, the user who interacted with the AI Chatbot, and a transcript of their conversation. </p></figcaption></figure>

Clicking a Transcript will reveal a **Conversation View**. This reveals the relevant dialogue captured by our system. It has the following components:

* **Name:** The name of the Chat Flow involved. In this case, it's a Chatbot named "Chatbot - Guidebot V2."
  * **Last Activity:** The last activity of the Channel.
  * **Channel:** The Channel implementation type, in this case a Web Widget.&#x20;
* **First Name/Last Name:** The name of the user. They are given a default name if they don't provide them to the AI Chatbot.
* **IP Address:** The IP Address where the AI Chatbot was accessed.
* **Device:** The kind of device used to converse with the AI Chatbot.
* **Phone Number:** The phone number of the user.
* **Email:** The email address of the user.

<figure><img src="/files/spqKLfUjsDjxCNuszpdN" alt="Additional options for transcripts in the Conversation View. Users can use the search bar to look for a specific message, or click the hamburger toggle to export the conversation into a PDF or report issues to the Captivate Chat team."><figcaption><p>Additional options for transcripts in the Conversation View. Users can use the search bar to look for a specific message, or click the hamburger toggle to export the conversation into a PDF or report issues to the Captivate Chat team.</p></figcaption></figure>

On the upper right of the Conversation View are other settings:

* **Search Message:** Lets users find a specific text, phrase, or message in the transcript.
* **Settings:** The hamburger menu has additional options
  * **Export PDF:** Exports the conversation as a PDF file
  * **Report Issues:** Lets you describe an issue with the conversation that the Captivate Chat team can review.

***

## Modifying a Transcript

<figure><img src="/files/UAGJpXPioxjp30FGggTT" alt="Clicking a specific Transcript conversation gives the option to Delete it, as seen by the &#x22;Delete&#x22; button."><figcaption><p>Clicking a specific Transcript conversation gives the option to Delete it, as seen by the "Delete" button.</p></figcaption></figure>

If you click the checkbox beside the conversation of your choice, the system will select it. You can then click the **Delete** button to permanently remove this transcript from your account.&#x20;

Deleting a Transcript conversation is permanent and irreversible. &#x20;


# Tokens

<figure><img src="/files/bGTulAoghrprLQRNciqv" alt="A view of the Tokens that users have currently used versus how many Tokens are left in their account, alongside a countdown on the nearest Monthly Usage Reset and their Extra Tokens."><figcaption><p>A view of the Tokens that users have currently used versus how many Tokens are left in their account, alongside a countdown on the nearest Monthly Usage Reset and their Extra Tokens.</p></figcaption></figure>

While AI Chatbots you create in Captivate Chat are extremely intelligent, they still follow specific programming. They need to process the data (actual data or conversations) they receive in a certain way which involves "breaking" them into "chunks" called **Tokens**.

AI Chatbots and Tokens interact through the following processes:

* **Ingesting resources:** Documents you upload and URLs you provide under [Import Your Own Information](/start-creating/create-an-ai-chatbot/import-your-own-information) as well as Q\&A CSVs you upload in [Train your AI Chatbot](/start-creating/create-an-ai-chatbot/train-your-ai-chatbot) need Tokens to be ingested and properly analysed by your AI Chatbot.&#x20;
* **Training your AI Chatbot:** Responses your AI Chatbot generates for questions in [Select Type](/start-creating/create-an-ai-chatbot/select-type) and [Train your AI Chatbot](/start-creating/create-an-ai-chatbot/train-your-ai-chatbot) require Tokens to process.
* **Previewing your Web Widget:** Checking the performance of your Web Widget Chat Flow in [Preview your Web Widget](/start-creating/create-a-chat-flow/select-channel/channel-web-chat/preview-your-web-widget) requires Tokens.

Creating Tokens takes time and processing power, which our awesome developers at Captivate Chat managed to streamline like a well-oiled machine. However, users have to avail a Captivate Chat plan to benefit from using Tokens whenever they create and test AI Chatbots, Chat Flows, and other Captivate Chat services.&#x20;

***

## Token Components

The *Token* view on the internal dashboard has the following components:

* **Tokens (Total):** This contains a metric of how many Tokens your account has used for the month versus your monthly total.
* **Monthly Usage Reset:** This is a countdown to the next monthly usage reset that replenishes your maximum Tokens for more Captivate Chat activities.
* **Extra Tokens:** This lists the number of Extra Tokens you have purchased on top of your Monthly Total.&#x20;


# Settings

Use My Account to edit your account settings

<figure><img src="/files/KqglGGN7IN7gj6DSMfI7" alt="The &#x22;Settings&#x22; view of the user. This can be accessed by selecting either &#x22;Edit Profile,&#x22; &#x22;Manage Plan,&#x22; or &#x22;Account Details&#x22; after clicking the user&#x27;s profile picture on the upper-right side of the Captivate Chat internal dashboard."><figcaption><p>The "Settings" view of the user. This can be accessed by selecting either "Edit Profile," "Manage Plan," or "Account Details" after clicking the user's profile picture on the upper-right side of the Captivate Chat internal dashboard.</p></figcaption></figure>

The ***Settings*** view of your Captivate Chat account reveals more settings you can check and modify for your account. There's no allocated "Settings" button for this view, and you should instead do the following:

* Click your profile picture on the upper-right side of the internal Captivate Chat dashboard.
* Click either *"Edit Profile," "Manage Plan,"* or *"Account Details."*&#x20;

***

## Settings Tabs

The *Settings* view of your Captivate Chat account has the following tabs:

* **Edit Profile:** Modify basic details such as your display name, contact details, and avatar.
* **Manage Plan:** Select or upgrade your current Captivate Chat plan.
* **Referrals:** Copy your Referral Link and earn whenever a colleague registers a Captivate Chat account using that URL.
* **Account Details:** Change more advanced account settings such as your password and email address. This is also where you can delete your account.
* **Transaction History:** View transactions you have made with Captivate Chat.


# Edit Profile

Edit basic profile details of your Captivate account

<figure><img src="/files/WF9knYrim2HopX0LPXWS" alt="Access the &#x22;Edit Profile&#x22; tab by clicking your profile picture on the upper-right side of the internal Captivate Chat dashboard and selecting &#x22;Edit Profile&#x22; under &#x22;My Account.&#x22;"><figcaption><p>Access the "Edit Profile" tab by clicking your profile picture on the upper-right side of the internal Captivate Chat dashboard and selecting "Edit Profile" under "My Account."</p></figcaption></figure>

Use the ***Edit Profile*** tab of the account settings view to change basic information about your Captivate Chat profile. To access this, do the following:

* Click your profile picture on the upper-right side of the Captivate Chat internal dashboard.
* Under ***My Accounts*****,** select *Edit Profile.*

***

## Edit Profile Components

<figure><img src="/files/wFWnYM2EGHGOYv12bPAc" alt="Use the &#x22;Edit Profile&#x22; tab under the settings view to change basic components about your account like your First Name, Last Name, Mobile Number, and Profile Picture."><figcaption><p>Use the "Edit Profile" tab under the settings view to change basic components about your account like your First Name, Last Name, Mobile Number, and Profile Picture.</p></figcaption></figure>

The *Edit Profile* settings tab has the following components:

* **First Name:** Put your first name.
* **Last Name:** Put your last name.
* **Mobile Number:** Type your phone number.
* **Profile Picture:** Select the avatar you want to use with your Captivate Chat account.&#x20;


# Manage Plan

<figure><img src="/files/mgUUERjiXFs6MlnOGlYj" alt="Access the &#x22;Manage Plan&#x22; tab of your Captivate Chat settings by clicking &#x22;Manage Plan&#x22; on the bottom-left part of the internal dashboard or by selecting your profile picture on the upper-right side of the internal dashboard and clicking &#x22;Manage Plan.&#x22;"><figcaption><p>Access the "Manage Plan" tab of your Captivate Chat settings by clicking "Manage Plan" on the bottom-left part of the internal dashboard or by selecting your profile picture on the upper-right side of the internal dashboard and clicking "Manage Plan."</p></figcaption></figure>

Use the ***Manage Plan*** tab of the account settings view to see and/or change your current billing program under Captivate Chat. To access this, do the following:

* Click *Manage Plan* on the lower-right side of the Captivate Chat internal dashboard.&#x20;
* Click your profile picture on the upper-right side of the Captivate Chat internal dashboard.
  * Under ***My Accounts*****,** select *Manage Plan.*

***

## Manage Plan Components

<figure><img src="/files/9fxxyokQWjOy19Rt4TeH" alt="Use the &#x22;Manage Plan&#x22; tab under the settings view to see and modify your current account plan with Captivate Chat. You can select a Basic, Pro, and Customized Plan with different benefits and choose to have the plans billed monthly or annually."><figcaption><p>Use the "Manage Plan" tab under the settings view to see and modify your current account plan with Captivate Chat. You can select a Basic, Pro, and Customized Plan with different benefits and choose to have the plans billed monthly or annually.</p></figcaption></figure>

<figure><img src="/files/GdZIkSRjW6cx5lCXrX2r" alt=""><figcaption></figcaption></figure>

There are currently three (3) different Captivate Chat plans you can choose from:

|                                   |    Basic Plan   |                   Pro Plan                  |                    Customized Plan                   |
| :-------------------------------: | :-------------: | :-----------------------------------------: | :--------------------------------------------------: |
|          **Included Bot**         |   Open AI GPT   |                 Open AI GPT                 | Any Bot (Unlimited AI Engineering hours every month) |
| **Number of Agents and Channels** |    Unlimited    |                  Unlimited                  |          Unlimited (including Integrations)          |
|   **Number of Tokens Per Month**  | Up to 1 Million | Up to 5 Million (buy extra 500k for USD 29) |                       Unlimited                      |
|     **Bill (if Paid Monthly)**    |      USD 29     |                    USD 99                   |                          POA                         |
|    **Bill (if Paid Annually)**    |     USD 300     |                   USD 999                   |                          POA                         |


# Account Details

<figure><img src="/files/OW91vfypoG3q7YxQLeWg" alt=""><figcaption><p>View the "Account Details" tab of your settings by clicking your profile picture on the upper-right side of the Captivate Chat internal dashboard and click "Account Details."</p></figcaption></figure>

Use the ***Account Details*** tab of the account settings view to change advanced information about your Captivate Chat profile. To access this, do the following:

* Click your profile picture on the upper-right side of the Captivate Chat internal dashboard.
* Under ***My Accounts*****,** select *Account Details.*

***

## Account Details Components

<figure><img src="/files/IHUVvWFezC1I5W8GxsBG" alt="Use the &#x22;Account Details&#x22; tab under the settings view to change advanced components about your account like your Email Address, Password, Developer Mode, and even Delete Account."><figcaption><p>Use the "Account Details" tab under the settings view to change advanced components about your account like your Email Address, Password, Developer Mode, and even Delete Account.</p></figcaption></figure>

<figure><img src="/files/XyVx9lTZZPCYBqvDJKXj" alt=""><figcaption><p>Use the "Account Details" tab under the settings view to change advanced components about your account like your Email Address, Password, Developer Mode, and even Delete Account.</p></figcaption></figure>

The *Account Details* settings tab has the following components:

* **Email/Confirm Email Address:** Add and confirm your new email address.
* **Current/New Password:** Add and confirm your new password.
* **Developer Mode:** Enable advanced features and debugging tools for developers.
* **Delete Account:** Delete your Captivate Chat account alongside all information and data with it. This is irreversible.&#x20;


# Referrals

Earn while using the Captivate platform!

<figure><img src="/files/IrUwUVa7VzSFVLtlh8fE" alt="Accessing the &#x22;Referrals&#x22; tab can be done by clicking on the &#x22;Referrals&#x22; button on the lower-left side of the Captivate Chat internal dashboard, and when loading the settings after clicking any option (Edit Profile, Manage Plan, Account Details) from your profile icon on the upper-right side of the dashboard."><figcaption><p>Accessing the "Referrals" tab can be done by clicking on the "Referrals" button on the lower-left side of the Captivate Chat internal dashboard, and when loading the settings after clicking any option (Edit Profile, Manage Plan, Account Details) from your profile icon on the upper-right side of the dashboard.</p></figcaption></figure>

When you create a Captivate Chat account, you can become an **Affiliate**. This allows you to refer Captivate Chat to colleagues and earn **30% commission** when they register using your Referral Link.

In order to access your **Referral Link**, you have to go to the ![Accessing the "Referrals" tab can be done by clicking on the "Referrals" button on the lower-left side of the Captivate Chat internal dashboard, and when loading the settings after clicking any option (Edit Profile, Manage Plan, Account Details) from your profile icon on the upper-right side of the dashboard.](/files/E1avkWwcPiTG8Hz3OZMJ) tab by following these steps:&#x20;

* Click the  ![Accessing the "Referrals" tab can be done by clicking on the "Referrals" button on the lower-left side of the Captivate Chat internal dashboard, and when loading the settings after clicking any option (Edit Profile, Manage Plan, Account Details) from your profile icon on the upper-right side of the dashboard.](/files/E1avkWwcPiTG8Hz3OZMJ) icon found on the lower-left part of the Captivate Chat internal dashboard.&#x20;
* Click your profile icon. Select either *Edit Profile, Manage Plan*, or *Account Details* to load your settings.  ![Accessing the "Referrals" tab can be done by clicking on the "Referrals" button on the lower-left side of the Captivate Chat internal dashboard, and when loading the settings after clicking any option (Edit Profile, Manage Plan, Account Details) from your profile icon on the upper-right side of the dashboard.](/files/E1avkWwcPiTG8Hz3OZMJ) should appear as a tab.&#x20;

***

## Referrals Tab&#x20;

<figure><img src="/files/Km2kiiToTjGTM1UIaJOx" alt="The &#x22;Referrals&#x22; tab of the settings view has a Referral Link, a list of &#x22;This Month&#x27;s Earnings&#x22; and &#x22;Total Earnings,&#x22; and a list of &#x22;Current Referrals&#x22; alongside their Email Address, Date &#x26; Time of referral, and Status. "><figcaption><p>The "Referrals" tab of the settings view has a Referral Link, a list of "This Month's Earnings" and "Total Earnings," and a list of "Current Referrals" alongside their Email Address, Date &#x26; Time of referral, and Status. </p></figcaption></figure>

The *Referrals* tab has the following components:

* **Referral Link:** This is your main way of earning commissions from referrals. You can copy your referral link to directly send to a friend or click a button send it through an email.
* **This Month's Earnings:** This details how much you've earned for this month in terms of commissions.
* **Total Earnings:** This indicates how much you've earned since you've started inviting referrals.
* **Current Referrals:** This is a list of your current referrals. They are listed based on Email Address, Date & Time of registration, and their Status as a Captivate Chat member.&#x20;


# Create an AI Chatbot

Design AI Chatbots to perform various tasks

You can use the Captivate platform to **create your AI Chatbot**. They can be custom-tailored to fit specific functionalities, fed information to improve their knowledge base, and trained with specific questions and answers.&#x20;

{% hint style="info" %}
**SUMMARY**

Creating an AI Chatbot with Captivate is fast and easy. You can do it in a few steps:

1. **Set up your AI Chatbot:** Give it a name and logo. This is for internal purposes and makes your AI Chatbot easy to track by the time you make a lot of them in the platform.
2. **Upload your data:** The *Import Your Own Information* page lets you paste URLs and upload PDFs to be ingested as data. Your AI Chatbot will use this as its knowledgebase.
3. **Select a template:** The *Select Type (Prompts)* page lets you choose a pre-made personality template for your AI Chatbot. You can edit this further with prompts in specialized options.
4. **Conduct training:** The *Train Your AI Chatbot* page lets you ask questions, correct answers, and even upload CSV spreadsheet files as Q\&A sources of your AI Chatbot.&#x20;
5. **Select integration:** Include additional features to your AI Chatbot, such as functionalities supported by third-party programs (connected via Zapier Actions) or creating Mini Courses courtesy of Captivate's Athena.
   {% endhint %}

To start creating your AI Chatbots, proceed with the following steps:


# Setting Up

Give your new AI Chatbot a name and logo before setting up its parameters.

<figure><img src="/files/SusOmqtiq1O4c5Hm0dQU" alt="In Setup > My AI Chatbots, you will be taken to a &#x22;My AI Chatbots&#x22; page that lists your current AI Chatbots. Click the blue &#x22;+AI Chatbot&#x22; button to start the AI Chatbot-creation process."><figcaption><p>In Setup > My AI Chatbots, you will be taken to a "My AI Chatbots" page that lists your current AI Chatbots. Click the blue "+AI Chatbot" button to start the AI Chatbot-creation process.</p></figcaption></figure>

Before you create your AI Chatbot, you have to set it up first.&#x20;

Under the ***Setup > AI Chatbot*** view, click ![Click the blue "+AI Chatbot" button to start the AI Chatbot-creation process.](/files/jvUMt21oJ1B590t6Te6i).&#x20;

<figure><img src="/files/ndd2aGJAKbH3wHci6jXT" alt="A &#x22;New AI Chatbot&#x22; window appears after clicking the &#x22;+AI Chatbot&#x22; button in the &#x22;My AI Chatbots&#x22; page. "><figcaption><p>A "New AI Chatbot" window appears after clicking the "+AI Chatbot" button in the "My AI Chatbots" page.</p></figcaption></figure>

A pop-up window should appear. Under the ***New AI Chatbot*** window, fill up the following:

* **Name Your AI Chatbot:** Assign a name to your AI Chatbot that corresponds to your needs.&#x20;
* **Upload Logo:** This will remind you the purpose of the bot. Your logo should be square and of moderate resolution (e.g. 100 pixels x 100 pixels). You can remove the logo by clicking on the ![Use the Trashbin icon to delete the current uploaded logo in the "New AI Chatbot" menu.](/files/2BNhxnGY2sSxiG4zu2mw) and replace it at any time.&#x20;

Click ![The blue "Done" button is clicked when the name and logo of the new AI Chatbot under the "New AI Chatbot" menu is finalized.](/files/P8YAhA1oYoXZi7Rx9Q6z) when you're finished.

{% hint style="info" %}
**Naming is important!**

If you plan on making multiple Chatbots, naming and labeling them with a Name and Logo makes them easier to organize.&#x20;

You may wish to use a version number or some other standard that makes it easier to follow the meaning of the bot. For example, `“My Bot v1.0”`
{% endhint %}

{% hint style="warning" %}
**Your AI Chatbot's name in "My AI Chatbots" is for internal use only!**

When you create an AI Chatbot in Captivate, its name under "Name Your AI Chatbot" is for internal use only. This will only be visible to you and the Captivate team.&#x20;

Your AI Chatbot can appear under a different public name through a Chat Flow, depending on the Channels you choose and how to customize them!
{% endhint %}

***

## Change the Name and Logo anytime

<figure><img src="/files/zw5IU7CMXkrQ5rds0iFq" alt="At any point during the AI Chatbot customization phase, you can click the Pencil Icon to go to the &#x22;Update AI Chatbot&#x22; menu and change your AI Chatbot&#x27;s internal name and logo."><figcaption><p>At any point during the AI Chatbot customization phase, you can click the Pencil Icon to go to the "Update AI Chatbot" menu and change your AI Chatbot's internal name and logo.</p></figcaption></figure>

As you work through the steps to define your AI Chatbot you can edit its Name or Logo by clicking on the **pencil icon** **(** ![Click the Pencil Icon at any point during the AI Chatbot customization phase to open the "Update AI Chatbot" menu.](/files/nWOhO3uEEyD7l16rJwVt) **)** in the field at the top of the page.&#x20;


# Select AI Platform

<figure><img src="/files/8k82EMG0ZMri4NPo8htz" alt=""><figcaption><p>Available options for an AI Platform include OpenAI, AWS Lex, and IBM Watson Assistant</p></figcaption></figure>

After naming your AI Chatbot, you will be taken to the **AI Chatbot** view. This is where you will customize the features of your new Chatbot.&#x20;

Choose the AI Platform you want as the basis of your Chatbot. This determines the kind of programming used by your AI Assistant.

After you've made your choice, click ![](/files/6jO7IheGczyZiwN0mxQo)

{% hint style="warning" %}
**As of 8/26/2024**

We removed the ***Select AI Platform*** part of our current process. After naming your AI Chatbot, you will be sent straight to ***Import Your Own Information***.
{% endhint %}

{% hint style="warning" %}
**As of 8/22/2024**

We are currently only offering **OpenAI** as the AI Platform of our AI Assistants. More platforms will be unlocked soon, and we'll explain their differences once they arrive!
{% endhint %}


# Import Your Own Information

Upload data for your AI Chatbot to ingest as part of its knowledgebase.

<figure><img src="/files/PHIzQAXNG2CkLPEeNdly" alt="After giving your AI Chatbot a name and logo, you will be taken to &#x22;Import Your Own Information.&#x22; This menu contains a list of resources you uploaded, and the option to upload new data."><figcaption><p>After giving your AI Chatbot a name and logo, you will be taken to "Import Your Own Information." This menu contains a list of resources you uploaded, and the option to upload new data.</p></figcaption></figure>

After you give your AI Chatbot a name and a logo, it's time to give it basic resources to learn from.&#x20;

On the left side of the AI Chatbot creation dashboard, click **Information** to go to the ***Import Your Own Information*** page.

## Import Your Information Page

It's in the ***Import Your Own Information*** page where you will establish your AI Chatbot's knowledgebase by uploading data.&#x20;

Importing your own information or uploading your data is the most important step in AI Chatbot creation. This is what the bot uses to answer user questions.

Make sure the information you will include has everything you want the Chatbot to use as a reference. In-depth sources can provide more accurate and reliable responses from your new Chatbot.&#x20;

{% hint style="info" %}
**The more the merrier!**

Think of this process as building the encyclopedia your Chatbot will rely on when answering customers. Since your Chatbot is an "intelligent" model, it knows how to combine information from different sources. This is where you come in. \
\
The more resources you provide, the more information your Chatbot can access when creating responses!
{% endhint %}

To visit the *Import Your Own Information* page, you need to click the !["Add Information" button on the side bar leads to "Import Your Own Information" page](/files/9y1uEemXTuxDl88CaGEY) button on the side bar of the AI Chatbot creation process.

Start the import process by clicking the ![Click the "Import" button on the top of the "Import Your Own Information" page to start the importation process to build your AI Chatbot's knowledge base.](/files/Qc2M7eMYt6gxEJ8igslO) button.

***

### Adding files and URLs to import

<figure><img src="/files/ckOqPxxQi7dnVH1wrBsJ" alt="The &#x22;Import&#x22; button of the &#x22;Import Your Own Information&#x22; page of the AI Chatbot creation process will let you insert files or URLs for ingestion. There are options to insert or drag-and-drop files, as well as an option to manually insert URLs (Direct Input) or auto-insert clusters of URLs (URL Crawler) "><figcaption><p>The "Import" button of the "Import Your Own Information" page of the AI Chatbot creation process will let you insert files or URLs for ingestion. There are options to insert or drag-and-drop files, as well as an option to manually insert URLs (Direct Input) or auto-insert clusters of URLs (URL Crawler) </p></figcaption></figure>

An ***Import*** pop-up window should appear. You can either:

* **Import:** Click or drag **PDF files** (up to 100MB) that contains important information that your Chatbot should know. You can drag multiple files at once by selecting a group of files and dragging them all to the file import area.
* **Direct Input:** List a set of URLs (one URL per line) that will become the basis of the knowledge of your Chatbot.&#x20;
* **URL Crawler:** Use a built-in web crawler to gather a group of URLs based on a root URL provided. Learn more about the URL Crawler here: [URL Crawler](/start-creating/create-an-ai-chatbot/import-your-own-information/url-crawler)

Once you have completed the files or webpages you want to import click on the ![Use the blue "Import" button to open the "Import" menu in order to add files and/or URLs to your Chatbot's database](/files/ZsgQgX9dHG1oJ5WLhlt6)button.

<figure><img src="/files/k5DZvPZoE986ZHjQfzFX" alt="After you upload your data and click the &#x22;Import&#x22; button in the &#x22;Import&#x22; menu, you will be taken to the &#x22;Proceed with Ingestion?&#x22; window. You will be given an estimated number of tokens required to ingest the data you just uploaded. Click &#x22;Import Selected&#x22; to proceed."><figcaption><p>After you upload your data and click the "Import" button in the "Import" menu, you will be taken to the "Proceed with Ingestion?" window. You will be given an estimated number of tokens required to ingest the data you just uploaded. Click "Import Selected" to proceed.</p></figcaption></figure>

You will be asked to pay a number of tokens to ingest the URL or PDF you've just uploaded. Click ![ Click "Import Selected" in "Proceed with Ingestion?" menu to start ingesting your uploaded information or data.](/files/wDCxBUcqGmtqnPECYAlH) to proceed.

{% hint style="danger" %}
**Import limit**

We limit the number of imports to support **a combination of up to 20 Files and URLs.**
{% endhint %}

{% hint style="success" %}
**We support a wide range of formats!**

Upload different file types to your knowledgebase such as PDF, WEB, DOC, DOCX, TXT, XPS, RTF, PPTX, CSV, XLSX, and XLS
{% endhint %}

***

### The import process

<figure><img src="/files/GiLXFCHmeqx4qWkpmK1t" alt=""><figcaption><p>A list of recently-uploaded resources are not clickable as they are still being ingested by the AI Chatbot. This process will go to "Allocating resources" then "Ingesting" before a successful ingestion. </p></figcaption></figure>

After clicking the ![ Click "Import Selected" in "Proceed with Ingestion?" menu to start ingesting your uploaded information or data.](/files/wDCxBUcqGmtqnPECYAlH) button, you will then see a list of the files or URL(s) being imported. Wait patiently as the information is ingested. Here are the status updates throughout the importation process:

<figure><img src="/files/nPQsGlzoWS8HQuicTspD" alt="The ingestion process of newly-uploaded data/resources starts with an &#x22;Allocating resources&#x22; message in &#x22;Import Your Own Information.&#x22; This will take a few minutes."><figcaption><p>The ingestion process of newly-uploaded data/resources starts with an "Allocating resources" message in "Import Your Own Information." This will take a few minutes.</p></figcaption></figure>

<figure><img src="/files/J5Ep8HxPreVugCGFAmUP" alt="After a few minutes of &#x22;Allocating resources&#x22; in &#x22;Import Your Own Information,&#x22; the system will give a message that ingestion has been completed."><figcaption><p>After a few minutes of "Allocating resources" in "Import Your Own Information," the system will give a message that ingestion has been completed.</p></figcaption></figure>

Please be patient. The time taken to import a PDF file or URL is dependent upon the size of the file or webpage.  You can return to import further information or remove information at any time. &#x20;

{% hint style="warning" %}
**Import again whenever you make updates!**

When you upload your resources to an AI Chatbot, they are only ingested **in their instance as of that moment.** This means the AI Chatbot doesn't auto-ingest your URL or PDF if you make any updates.

If you make any major changes to your resources, disable their original iteration and import the updated versions to your AI Chatbot.
{% endhint %}

***

### Restrict Data from Internet

<figure><img src="/files/9QnXNaYBmBrjW3RLKhGs" alt="A &#x22;Restrict Internet Data&#x22; toggle is located in the &#x22;Import Your Own Information&#x22; page during AI Chatbot setup. Toggle this to &#x22;Active&#x22; to restrict AI Chatbots into just using the information it contains, and toggle this it &#x22;Inactive&#x22; to allow AI Chatbots to search the internet for information."><figcaption><p>A "Restrict Internet Data" toggle is located in the "Import Your Own Information" page during AI Chatbot setup. Toggle this to "Active" to restrict AI Chatbots into just using the information it contains, and toggle this it "Inactive" to allow AI Chatbots to search the internet for information.</p></figcaption></figure>

<figure><img src="/files/8Yuq7SJzohnVC5FPyANe" alt="A &#x22;Restrict Data from Internet&#x22; toggle is located in the &#x22;Import Your Own Information&#x22; page during AI Chatbot setup. Toggle this to &#x22;Active&#x22; to restrict AI Chatbots into just using the information it contains, and toggle this it &#x22;Inactive&#x22; to allow AI Chatbots to search the internet for information."><figcaption><p>A "Restrict Data from Internet" toggle is located in the "Import Your Own Information" page during AI Chatbot setup. Toggle this to "Active" to restrict AI Chatbots into just using the information it contains, and toggle this it "Inactive" to allow AI Chatbots to search the internet for information.</p></figcaption></figure>

An additional feature in our *Import Your Own Information* page is the ability to force your AI Chatbot to only use data it can gather from your resources instead of getting more insights from the internet. This can be done by toggling **Active/Inactive** at the right-hand side of the screen.&#x20;

The AI Chatbot will take note of this and behave as requested in most circumstances but like us humans may not be able to help itself sometimes. Adjust any prompts accordingly to maximize the functionality of this toggle.

***

### Enable Citations

<figure><img src="/files/AZIASAd3plX4QdaTDA1O" alt="The &#x22;Citations&#x22; toggle is located in the &#x22;Import Your Own Information&#x22; page during AI Chatbot setup. Toggle this to &#x22;Enabled&#x22; so AI Chatbots send an extra response containing the sources of their previous message."><figcaption><p>The "Citations" toggle is located in the "Import Your Own Information" page during AI Chatbot setup. Toggle this to "Enabled" so AI Chatbots send an extra response containing the sources of their previous message.</p></figcaption></figure>

<figure><img src="/files/17rzon58gjHbamPwDPfq" alt="The &#x22;Enable Citations&#x22; toggle is located in the &#x22;Import Your Own Information&#x22; page during AI Chatbot setup. Toggle this to &#x22;Enabled&#x22; so AI Chatbots send an extra response containing the sources of their previous message."><figcaption><p>The "Enable Citations" toggle is located in the "Import Your Own Information" page during AI Chatbot setup. Toggle this to "Enabled" so AI Chatbots send an extra response containing the sources of their previous message.</p></figcaption></figure>

Another feature in our *Import Your Own Information* page is the **Enables Citations** feature. This is located as a toggle on the right side of the page. It has two options:

* **Enabled:** Setting "Enable Citations" to "Enabled" will make the AI Chatbot send a message with its sources whenever it responds to users. These sources are taken from the information ingested by the AI Chatbot. If the source was ingested as a URL, it will be clickable.
* **Disabled:** Setting "Enable Citations" to "Disabled" will not make the AI Chatbot send a message with its sources whenever it responds.&#x20;

#### Sample Citation

<figure><img src="/files/tXdOBzY1QxHn3p2t8r2A" alt="A sample interaction with a bot with &#x22;Enable Citations&#x22; set to &#x22;Enabled.&#x22; Notice how it sends two responses - one with the answer to the user query, and another containing its sources."><figcaption><p>A sample interaction with a bot with "Enable Citations" set to "Enabled." Notice how it sends two responses - one with the answer to the user query, and another containing its sources.</p></figcaption></figure>

Above is a conversation with a Web Widget with "Enable Citations" set as "Enabled." Whenever AI Chatbot responds to the user, it sends two responses:

1. The first response is the answer to the user query.
2. The second response is the source of its answers. Sources are clickable if they originated as URLs that the AI Chatbot creator uploaded during the AI Chatbot creation process.&#x20;

***

### Editing Ingested Information&#x20;

Once information has been ingested by your AI Chatbot, you can use the *Import Your Own Information* page to edit those specific data. You can do these options:

<figure><img src="/files/qmOFbbd8lhOQWiT4NhPI" alt="Clicking the checkbox beside the name of the ingested file inside &#x22;Import Your Own Information&#x22; page will select that specific file for editing. Selecting the checkbox beside the &#x22;Name&#x22; column will select all the ingested files of that page."><figcaption><p>Clicking the checkbox beside the name of the ingested file inside "Import Your Own Information" page will select that specific file for editing. Selecting the checkbox beside the "Name" column will select all the ingested files of that page.</p></figcaption></figure>

**Checkbox Select:** Click the checkbox beside the file name of the data you ingested to select that individual data. Alternatively, click the checkbox beside the *Name* column to select all data from that page.

<figure><img src="/files/AFzuQsqvnNVRzZd06VCQ" alt="Toggle the Status column of any file name to &#x22;Active&#x22; so the AI Chatbot uses it for its responses, and &#x22;Inactive&#x22; so the AI Chatbot doesn&#x27;t consider it for its answers."><figcaption><p>Toggle the Status column of any file name to "Active" so the AI Chatbot uses it for its responses, and "Inactive" so the AI Chatbot doesn't consider it for its answers.</p></figcaption></figure>

**Status Toggle:** You can toggle the status of your data in *Import Your Own Information* as Active or Inactive:

* **Active:** Toggling Status as *Active* means your AI Chatbot will use this file to get data for its responses.
* **Inactive:** Toggling Status as *Inactive* means your AI Chatbot will not use this file to get data for its responses.&#x20;

<figure><img src="/files/qML4im43kEF2LD0boxuJ" alt=""><figcaption><p>The "Delete" button is only clickable after selecting data you want to edit from the "Import Your Own Information" page.</p></figcaption></figure>

**Delete:** Click the *Delete* button beside the *Import* button to delete the selected file from your AI Chatbot's ingested data. This is only clickable after you select data using the checkbox beside the file name (to select specifc data) or beside the *Name* column (to select all data).&#x20;

***

Once your data has been imported, click![Click "Next" button from "Import Your Own Information" page to proceed to the next stage that involves choosing a template for the new AI Chatbot.](/files/m0ZXGHLNIGK2QX5w7UZV).

Or, click ![Clicking "Back" in the "Import Your Own Information" view will send users back to the "My AI Chatbots" page where they can select their AI Chatbot.](/files/mGbt3gcIkYESU7f7b9rD) to go to the ***My AI Chatbots*** page where you can choose your AI Chatbot or make a new one.

Alternatively, you can choose ![The "Finish" button at any stage in the AI Chatbot creation process will finish the editing process and return users to the Setup > My AI Chatbots menu.](/files/b4qGhLV6i8UeBo2x9uCT) to save your changes and go back to ***Setup > My AI Chatbots***.


# URL Crawler

<figure><img src="/files/erijvBNi9hWtpDGZ2pnN" alt="If you click the &#x22;Import&#x22; button of the &#x22;Select Your Own Information&#x22; page in the AI Chatbot creation process, you can access the URL Crawler by clicking its tab. You can then insert a root URL for crawling."><figcaption><p>If you click the "Import" button of the "Select Your Own Information" page in the AI Chatbot creation process, you can access the URL Crawler by clicking its tab. You can then insert a root URL for crawling.</p></figcaption></figure>

Thanks to the **URL Crawler**, you can now simply insert just one root URL (or main URL) and Captivate Chat will use a web crawler to gather all URLs located inside that website - no need to manually find them yourself.&#x20;

{% hint style="info" %}
**Use Direct Input if you have a specific set of URLs to ingest**

If you want your AI Chatbot to ingest and learn from all available URLs within a website, the URL Crawler is a convenient tool to use!&#x20;

**However,** you should use **Import >** **Direct Input** if you only have **a specific set of URLs** you want your AI Chatbot to ingest.
{% endhint %}

***

## Using the URL Crawler

<figure><img src="/files/siQXCmwo0CQBL6Ddw4Id" alt="To use the URL Crawler feature, insert the root URL or main URL you want to use as a source for the crawl. Captivate Chat will deploy a web crawler to look for all URLs nested under this source."><figcaption><p>To use the URL Crawler feature, insert the root URL or main URL you want to use as a source for the crawl. Captivate Chat will deploy a web crawler to look for all URLs nested under this source.</p></figcaption></figure>

To use the URL Crawler feature, simply place a **root URL** in the box provided and click the ![Clicking the "Submit" button under "Import Your Own Information" > Import > URL Crawler will prompt Captivate Chat to deploy a web crawler to find all pages found under that URL. ](/files/ybeqOEB0xnUErLX8BON6) button.

<figure><img src="/files/VdCaZDI0Xf9CAv7Tdzu4" alt="After clicking &#x22;Submit&#x22; under &#x22;Import Your Own Information&#x22; > Import > URL Crawler, Captivate Chat will list all URLs nested under your root URL. It will appear under the &#x22;Start deep crawl&#x22; pop-up window. You can then select the ones you want your AI Chatbot to ingest and click &#x22;Import Selected&#x22; to proceed."><figcaption><p>After clicking "Submit" under "Import Your Own Information" > Import > URL Crawler, Captivate Chat will list all URLs nested under your root URL. It will appear under the "Start deep crawl" pop-up window. You can then select the ones you want your AI Chatbot to ingest and click "Import Selected" to proceed.</p></figcaption></figure>

**Start deep crawl** will appear after listing your root URL. It will list all the URLs available under that main link.&#x20;

You can scroll down to choose which URLs you want your AI Chatbot to ingest, but you can also just click the checkbox beside the "URL" column name to select all the URLs listed in the crawl.&#x20;

***

## Wildcard Character

<figure><img src="/files/OhI6Woc4QhNJNTHukood" alt="Using a wildcard character or an asterisk (*) at the end of the last front slash of a root URL inside the URL Crawler will make the Captivate Chat web crawler look for all relevant URLs within that website layer."><figcaption><p>Using a wildcard character or an asterisk (*) at the end of the last front slash of a root URL inside the URL Crawler will make the Captivate Chat web crawler look for all relevant URLs within that website layer.</p></figcaption></figure>

If you want to make more precise searches with our URL Crawler, you can use what's called a **wildcard character or an asterisk (\*)** at the end of your root URL.

What this does is to command the Captivate Chat web crawler to only retrieve URLs of that specific website layer.  The Captivate Chat URL Crawler can retrieve from up to two (2) layers within a website. If we're using the above example:

### 1 Wildcard Character: `url.com/abc/*`

<figure><img src="/files/NrEZvEv2Ql4UjloY07Ff" alt="Using only one wildcard character or asterisk (*) in the Captivate Chat URL Crawler will only retrieve URLs of one layer beneath the  specified root URL."><figcaption><p>Using only one wildcard character or asterisk (*) in the Captivate Chat URL Crawler will only retrieve URLs of one layer beneath the specified root URL.</p></figcaption></figure>

If you only use **1 Wildcard Character or asterisk (\*)** in the format `url.com/abc/*` in the URL Crawler, then you should be able to retrieve all URLs one layer below your root URL.

As a more technical example, if your website has this kind of arrangement:

`/abc/def/123`&#x20;

`/abc/def/123/456`&#x20;

`/abc/ghi/123/456`&#x20;

`/abc/jkl/`

Then, inputting `/abc/*` in the URL Crawler will only retrieve:

`/abc/def/`

`/abc/ghi/`

`/abc/jkl/`

As we only crawled one layer downward.

{% hint style="info" %}
This is useful for retrieving all pages within a single website section, such as the specific subcategories within a category of products.&#x20;

For instance, a URL Crawler can give you all brands (subcategories) of laptop (laptop) in an electronics store.&#x20;
{% endhint %}

***

### 2 Wildcard Characters: `url.com/abc/**`

<figure><img src="/files/u2RcFPInECokCoeQgHN7" alt=""><figcaption><p>Using only two wildcard characters or asterisks (**) in the Captivate Chat URL Crawler will only retrieve URLs of one layer beneath the specified root URL.</p></figcaption></figure>

If you use **2 Wildcard Characters or asterisks (\*\*)** in the format `url.com/abc/**` in the URL Crawler, then you should be able to retrieve all the URLs under your root URL.

As a more technical example, if your website has this kind of arrangement:

`/abc/def/123`&#x20;

`/abc/def/123/456`&#x20;

`/abc/ghi/123/456`&#x20;

`/abc/jkl/`

Then, inputting `/abc/def/**` in the URL Crawler will only retrieve:

`/abc/def/123`&#x20;

`/abc/def/123/456`

As we allowed the URL Crawler to look for all pages under `/abc/def/`, including lower layers.

{% hint style="info" %}
This is useful for retrieving specific sub-types of a subcategory within a category of products.&#x20;

For instance, a URL Crawler will give you all models (sub-type) or even models of a specific year (deeper sub-type) of a brand (subcategory) of a laptop (category) in an electronics store.
{% endhint %}

***

After choosing the URLs you want to ingest, click ![Click "Import Selected" after choosing the files and URLs you want to import so your AI Chatbot can start ingesting the files. This button is available under "Import Your Own Information"](/files/4aeO40zbdo1pKsgd8VWT) to proceed.


# Select Type

Select your AI Chatbot "Type" to give it preset prompts

<figure><img src="/files/b9FHQ2dkm7T2C0K1VbcI" alt="The &#x22;Select Type (Prompts)&#x22; page in the AI Chatbot creation phase reveals a list of templates users can apply to their AI Chatbots to estalbish their base personality and functionalities."><figcaption><p>The "Select Type (Prompts)" page in the AI Chatbot creation phase reveals a list of templates users can apply to their AI Chatbots to estalbish their base personality and functionalities.</p></figcaption></figure>

After your AI Chatbot had ingested information as part of its database, you can assign it a personality that dictates how your AI Chatbot responds to queries and questions.

Check our list of templates in the ***Select Type*** page to see if any of them corresponds to the kind of AI Chatbot you want to create.&#x20;

We've already prepared AI Chatbot types you can select to meet specific functionalities. They are pre-programmed with behaviors to help them approach questions and tasks a specific way, making them "plug-and-play" for your convenience.&#x20;

<figure><img src="/files/ueIj6WQxboMVCyuU0h0q" alt="Some of the templates in the &#x22;Select Type&#x22; page. The selected template will be highlighted in blue."><figcaption><p>Some of the templates in the "Select Type" page. The selected template will be highlighted in blue.</p></figcaption></figure>

Access the *Select Type* page by clicking ![The "Add Type" button from the AI Chatbot creation process side bar gets you to the "Select Type" page.](/files/d5f84r2RM6d6YDTkSvcK) on the AI Chatbot creation side bar.&#x20;

Select your AI Chatbot type by **clicking on the tile** you're interested in.

***

## The different AI Chatbot types

<figure><img src="/files/heOsXm2wDurCvjJzzUlF" alt="The &#x22;Select Type (Prompts)&#x22; page will display your most recent selected and edited type as your &#x22;Current Type (Prompt)&#x22;. Click the &#x22;Customize (Advanced)&#x22; button in the &#x22;Select Type&#x22; page after selecting a template to edit its settings further in a separate menu."><figcaption><p>The "Select Type (Prompts)" page will display your most recent selected and edited type as your "Current Type (Prompt)". Click the "Customize (Advanced)" button in the "Select Type" page after selecting a template to edit its settings further in a separate menu.</p></figcaption></figure>

<figure><img src="/files/p76qLhyB0PvV7UQZLDCh" alt="Click the &#x22;Customize (Advanced)&#x22; button in the &#x22;Select Type&#x22; page after selecting a template to edit its settings further in a separate menu."><figcaption><p>Click the "Customize (Advanced)" button in the "Select Type" page after selecting a template to edit its settings further in a separate menu.</p></figcaption></figure>

Here's a more in-depth description of each AI Assistant Type in the ***Select Type*** page:&#x20;

* **Marketing Bot:** Assist in marketing and recommending products, specifically serving sales representatives dealing with prospective customers.&#x20;
* **Customer Support Bot:** Deliver technical support to customer representatives.&#x20;
* **Learning Assistant Bot:** Offer educational content on IT products and services, including linking to relevant resources and adapting to the learner's specific needs.&#x20;
* **Business Intelligence Bot:** Supply employees with instant, actionable insights on market trends, performance metrics, and operational data.&#x20;
* **Social Media Assistant** Bot: Aid businesses in mastering their social media landscape, facilitating audience engagement, and refining content strategies.&#x20;
* **Project Management Assistant Bot:** Facilitate project planning, tracking, and collaboration among team members.&#x20;
* **School Receptionist:** Helpfully answer questions from parents about school matters.&#x20;
* **Multiple Choice Bot:** Help students prepare for an exam. You will make sure that your opening will be a multiple-choice question with the provided format.

{% hint style="info" %}
**Use an AI Chatbot Type for your first time!**

If this is your first time creating your own AI Assistant, consider using one of our AI Chatbot Types. They are made specifically to help you meet a specific need as quickly as possible, so you can start integrating new functionalities to your website or business.&#x20;

You can always create more elaborate AI Assistants later!
{% endhint %}

***

## Customize your AI Chatbot type

Modify your AI Chatbot even further by clicking ![Click the "Customize (Advanced)" button in the "Select Type" page after selecting a template to edit its settings further in a separate menu.](/files/mxrFUOx0xQ9Gs2mXgUke)  **after you've made your choice of AI Chatbot variant.** This brings you to a new ***Customize Type*** window with adjustable parameters, as seen below:&#x20;

### Customize Type (Structured)

<figure><img src="/files/TNYYp73Ks0n6I2YeCj8i" alt="The &#x22;Structured&#x22; tab with pre-formatted questions to make it easy for users to determine how their AI Chatbot should act (Personality), what questions it should anticipate (Input Instructions), the way it should analyze and respond (Output Instructions) and the format the AI Chatbot should use when replying to users (Output Format)."><figcaption><p>The "Structured" tab with pre-formatted questions to make it easy for users to determine how their AI Chatbot should act (Personality), what questions it should anticipate (Input Instructions), the way it should analyze and respond (Output Instructions) and the format the AI Chatbot should use when replying to users (Output Format).</p></figcaption></figure>

Clicking ![Clicking "Customize (Advanced)" button in "Select Type" page reveals a "Customize Type" page. Users can use its two tabs to edit their template. ](/files/mxrFUOx0xQ9Gs2mXgUke) allows you to modify the parameters of the AI Chatbot type you've chosen. This allows you to dictate exactly how you want your AI Chatbot to "think" and engage users.&#x20;

Under the ***Customize Type (Structured)*** tab, we have prepared forms you can fill out with more specific instructions that you want the Chatbot to follow:&#x20;

* **Personality:** What kind of personality do you want the AI Chatbot to have when they interact with users? Are they professional, formal, or casual?&#x20;
* **Input Instructions:** What should the AI Chatbot expect when they analyze the questions or queries of users? How should they approach the thinking process?
* **Output Instructions:** What sort of output should the AI Chatbot provide users? How should they use the information they have to answer the user's query?
* **Output Format:** Do you have any specific format for the AI Chatbot to follow when they create responses? Should your responses focus on providing lists or paragraphs of text?

{% hint style="info" %}
**How should your AI Chatbot process the information it receives?**

While you've uploaded a lot of information in your AI Chatbot, they don't know how to process it yet. If you want your Chatbot to process the information a certain way, this is where you can edit it.&#x20;

You can find some inspiration from the preset answers included in the AI Assistant Type you've chosen.
{% endhint %}

### Customize Type (Free Format)

<figure><img src="/files/GFYMchwYsUygeikmrNbe" alt="The &#x22;Free Format&#x22; tab under &#x22;Customize Type&#x22; after clicking &#x22;Customize (Advanced)&#x22; in the &#x22;Select Type&#x22; page of the AI Chatbot creation process. This &#x22;Free Format&#x22; tab has one textbox where users can create the AI Chatbot prompt from scratch."><figcaption><p>The "Free Format" tab under "Customize Type" after clicking "Customize (Advanced)" in the "Select Type" page of the AI Chatbot creation process. This "Free Format" tab has one textbox where users can create the AI Chatbot prompt from scratch.</p></figcaption></figure>

Alternatively, you can choose the ***Customize Type (Free Format)*** tab to create your own instructions. There is a sample in the ***Custom Prompts** t*ext box so you can have a basis on how you can instruct your customized AI Chatbot.

The **Custom Prompts** text box is a fully customizable prompt with no formatting, allowing you to write elaborate instructions without the constraints of the Structured format.

{% hint style="info" %}
**Be as elaborate in your prompts as you want!**

A **prompt** is a series of instructions that your AI Chatbot uses as a basis of its "thought process." Prompts can be as simple as asking the AI Chatbot to do something, or as complex as giving it a set of elaborate instructions.&#x20;

We can create in-depth prompting guides to help you develop more elaborate Chatbots!
{% endhint %}

***

## Chat History Configuration

<figure><img src="/files/IzqCKY9FWvDpkWZoe45G" alt="&#x22;Use Full Chat History for AI Context&#x22; enables the AI to access and analyze the entire chat history within a session, ensuring the highest level of contextual understanding. This approach utilizes more tokens, offering maximum accuracy as the AI has full access to all prior interactions."><figcaption><p>"Use Full Chat History for AI Context" enables the AI to access and analyze the entire chat history within a session, ensuring the highest level of contextual understanding. This approach utilizes more tokens, offering maximum accuracy as the AI has full access to all prior interactions.</p></figcaption></figure>

Use our **Chat History Configuration** to enable your AI Chatbot to use **previous conversations with the user** as the context for its current responses:

* **Toggled ON:** When this feature is toggled on, Captivate Chat will **consume more tokens** but will result in the **highest-possible accuracy** when conversing with users. This is because the AI Chatbot will be taking into consideration all prior sessions with the user when forming its responses.
* **Toggled OFF:** When this feature is turned off, Captivate Chat employs an optimized algorithm to determine relevance, using a significance score (cut-off 0.70) to include only the most contextually relevant interactions. This method **conserves tokens** but may result in **slightly reduced accuracy**.

{% hint style="info" %}
**What Chat History Configuration is best for my AI Chatbot?**

This depends on your AI's specific requirements:

* **Toggle full chat history ON** if your AI Chatbot needs to rely heavily on historical context, such as when interacting with bots in the healthcare industry where they need your prior data.
* **Toggle full chat history OFF** if your AI Chatbot doesn't need to rely on prior conversations with users, such as with homepage bots.&#x20;
  {% endhint %}

***

## Testing your AI Chatbot Type

<figure><img src="/files/ivtj29HPcT6kBj8GcK0x" alt="There is a &#x22;Test Your AI Chatbot&#x22; window in the &#x22;Customize Type&#x22; window after clicking &#x22;Customize (Advanced)&#x22; in the &#x22;Select Type&#x22; page of the AI Chatbot creation process.  This &#x22;Test Your AI Chatbot&#x22; window is a live conversation with the current iteration of the AI Chatbot that users can talk to while modifying the AI Chatbot template."><figcaption><p>There is a "Test Your AI Chatbot" window in the "Customize Type" window after clicking "Customize (Advanced)" in the "Select Type" page of the AI Chatbot creation process.  This "Test Your AI Chatbot" window is a live conversation with the current iteration of the AI Chatbot that users can talk to while modifying the AI Chatbot template.</p></figcaption></figure>

While choosing your AI Chatbot Type and editing their prompts further under Customize (Structured/Free Format), you might notice the ***Test Your AI Assistant*** window with a text box on the right side of the screen.

This is a live version of the AI Chatbot you are currently designing. You can plug in questions and wait for responses. Feel free to customize other parts of your AI Chatbot and see how it can affect its responses in real time. Refresh the conversation at any time to restart your chat.

By the time you used this testing box to create the "perfect" tone of voice for your AI Chatbot, now's the time to start training.

{% hint style="info" %}
**Experiment with your fully functional AI Chatbot**

By the time you reach this step, your AI Chatbot is "technically" fully functional. The only steps missing are refining its responses through training and connecting it to your Live Chat.
{% endhint %}

***

## Updating your AI Chatbot Type

<figure><img src="/files/9KNkYfOO2ebXxWgVLCoB" alt="The &#x22;Select Type (Prompts)&#x22; will display your chosen Type for the AI Chatbot under &#x22;Current Type (Prompt)&#x22; and you can modify it at any time by clicking &#x22;Edit.&#x22;"><figcaption><p>The "Select Type (Prompts)" will display your chosen Type for the AI Chatbot under "Current Type (Prompt)" and you can modify it at any time by clicking "Edit."</p></figcaption></figure>

Once you have chosen your AI Chatbot Type, it will be selected in the **Current Type (Prompt)** section above the list of AI Chatbot Types. You can click the  ![This light blue "Edit" button beside the AI Chatbot Type labeled as the "Current Type (Prompt)" will take viewers to the "Customize (Advanced)" page for this chosen AI Chatbot Type.](/files/8YnEvVmAoQ6irSB4yeWQ) to modify your current AI Chatbot Type's properties.

### Choosing another AI Chatbot Type

<figure><img src="/files/LJEmNpZXttp5cJgT4BZo" alt="If you click another AI Chatbot Type aside from the one selected as your Current Type, you will see this warning. If you click &#x22;Confirm&#x22; the new Type will replace your old one. This change is irreversible."><figcaption><p>If you click another AI Chatbot Type aside from the one selected as your Current Type, you will see this warning. If you click "Confirm" the new Type will replace your old one. This change is irreversible.</p></figcaption></figure>

{% hint style="danger" %}
**Changing your Current Type (Prompt) will reset everything!**

If you replace your Current Type with a new AI Chatbot Type, you have to reconfigure this new selection. You cannot revert to your old selection.
{% endhint %}

***

## After choosing an AI Chatbot Type

You can proceed with the next step in three (2) ways:

* Click ![Clicking "Back" in the "Customize Type" view will send users back to the "Select Type" page.](/files/mGbt3gcIkYESU7f7b9rD) to go to the main ***Select Type (Prompts)*** page. Choose ![Clicking the "Next" button in the "Customize Type" view sends users to the "Train Your AI Chatbot" page.](/files/0Q09rnNY70lZXummQsKq)  on the lower right-hand corner.
* In the ***Customize Type*** view, choose ![Clicking the "Next" button in the "Customize Type" view sends users to the "Train Your AI Chatbot" page.](/files/dTk9vUGt2iQaD6T5eDAq) on the lower right-hand corner.&#x20;
* In either view, you can choose ![The "Finish" button at any stage in the AI Chatbot creation process will finish the editing process and return users to the Setup > My AI Chatbots menu.](/files/b4qGhLV6i8UeBo2x9uCT) to save your changes and go back to ***Setup > My AI Chatbots***.

***

##


# Train your AI Chatbot

<figure><img src="/files/g5y00MqoMRmgKHYMpnkV" alt="In the &#x22;Train Your AI Chatbot&#x22; page of the AI Chatbot creation process, there are options to ask questions to your AI Chatbot, see its responses, correct any wrong responses, and even upload pre-set Q&#x26;A files."><figcaption><p>In the "Train Your AI Chatbot" page of the AI Chatbot creation process, there are options to ask questions to your AI Chatbot, see its responses, correct any wrong responses, and even upload pre-set Q&#x26;A files.</p></figcaption></figure>

After uploading data and assigning a template to your AI Chatbot, it's time to help your AI Chatbot learn and evolve from its knowledge base through **training**.&#x20;

Similar to how muscles are trained and "practiced" getting used to new activities, a AI Chatbot new interactions to "practice" its responses and learn from new knowledge.

In Captivate Chat, the ***Train Your AI Chatbot*** page lets you stress-test your AI Chatbot with questions and correct any mistakes in real time.

{% hint style="warning" %}
**It only uses ingested information!**

**Train Your AI Chatbot** lets you test your AI Chatbot's understanding of your ingested knowledge. It will not reflect what you prompted in **Select Type** regarding personality and formats.

This will explain why it doesn't "respond" in a similar manner as the AI Chatbot in **Select Type**.&#x20;
{% endhint %}

{% hint style="info" %}
**Talk to your AI Chatbot - it literally uses your inputs to learn!**

Our AI Chatbots are capable of performing what's called **NLP** or natural language processing. This process combines their internal programming (machine learning) and linguistics to help them "learn" from interactions.&#x20;

Providing new questions and answers, as well as feedback, to your AI Chatbot slowly "shapes" its thought processes - allowing it to perform exactly how you need it to.&#x20;
{% endhint %}

To access the *Train Your AI Chatbot* page, click ![Click "Train" on the side bar of the AI Chatbot creation process to access the "Train Your AI Chatbot" page.](/files/LkUdSmaPfA6iy18KAi9L) on the side bar of the AI Chatbot creation process.

The *Train your AI Chatbot* page has these major components:&#x20;

***

## Enter your test question

<figure><img src="/files/ZGYk8sGaRKmu8C1GVHgq" alt="In the &#x22;Enter your test question&#x22; part of the &#x22;Train Your AI Chatbot&#x22; page, you can give your AI Chatbot a test question that it will answer."><figcaption><p>In the "Enter your test question" part of the "Train Your AI Chatbot" page, you can give your AI Chatbot a test question that it will answer.</p></figcaption></figure>

<figure><img src="/files/YMkkWE4dEX6X00EQ6tNA" alt="In the &#x22;Enter your test question&#x22; part of the &#x22;Train Your AI Chatbot&#x22; page, you can give your AI Chatbot a test question that it will answer."><figcaption><p>In the "Enter your test question" part of the "Train Your AI Chatbot" page, you can give your AI Chatbot a test question that it will answer.</p></figcaption></figure>

Write a test question in ***Enter Your Test Question*** that will gauge the Chatbot's response based on the current information in its knowledge base.

Once done, click ![Click "Submit" in the "Enter your test question" part of the "Train Your AI Chatbot" page to submit a test question to your AI Chatbot.](/files/Z1m0XWHJGS6xpHQapbtE)

***

## **Current Answer**

<figure><img src="/files/Pe9Qnj4fJhcJtAVeH0TE" alt="After you submit a test question, the &#x22;Current Answer&#x22; part of the &#x22;Train Your AI Chatbot&#x22; page will reveal your AI Chatbot&#x27;s answer according to its current knowledgebase and modified prompts."><figcaption><p>After you submit a test question, the "Current Answer" part of the "Train Your AI Chatbot" page will reveal your AI Chatbot's answer according to its current knowledgebase and modified prompts.</p></figcaption></figure>

The ***Current Answer*** will contain a response of your test question based on the Chatbot's current database.

***

## **Correct Answer**

<figure><img src="/files/Spr10BKS0t96yIVVcH2L" alt="Use the &#x22;Correct Answer&#x22; section of the &#x22;Train Your AI Chatbot&#x22; page to replace the answer of the &#x22;Current Answer&#x22; section beside it. Click &#x22;+Add to Q&#x26;A&#x22; to override the &#x22;Current Answer&#x22; with the &#x22;Correct Answer.&#x22;"><figcaption><p>Use the "Correct Answer" section of the "Train Your AI Chatbot" page to replace the answer of the "Current Answer" section beside it. Click "+Add to Q&#x26;A" to override the "Current Answer" with the "Correct Answer."</p></figcaption></figure>

Use the ***Correct Answer*** to put a new answer if the response in the *Current Answer* is wrong or has to be modified.

Once done, click ![Click "+Add to Q\&A" to override the "Current Answer" with the "Correct Answer."](/files/gqDZ1HsRc3x9M8mMGNVO)

***

## Trained Questions and Answers

<figure><img src="/files/a0YvHTbLjukGrwffGvg6" alt="The &#x22;Trained Questions and Answers&#x22; part of the &#x22;Train Your AI Chatbot&#x22; page will contain the Test Question and the Correct Answer you&#x27;ve just submitted."><figcaption><p>The "Trained Questions and Answers" part of the "Train Your AI Chatbot" page will contain the Test Question and the Correct Answer you've just submitted.</p></figcaption></figure>

The ***Trained Questions and Answers*** segment contains the list of Questions, Correct Answers, and Messages that have been inserted by the user.&#x20;

### **+Add with CSV**

Insert your own list of questions and answers as a CSV file instead of manually typing them.  To do this, click ![Click the "+Add with CSV" button to submit a CSV spreadsheet file containing Q\&As that your AI Chatbot will refer to.](/files/u8DOOwFh9JxHKwulb5oW).

<figure><img src="/files/yywcqFHjVn4qXu7F6WdJ" alt=""><figcaption><p>Use the "Submit Additional Q&#x26;A" window to upload a CSV spreadsheet of Q&#x26;A pairs you want your AI Chatbot to use. Click the "+Add Q&#x26;A" button after uploading your CSV file to officially insert your Q&#x26;A pairs into your AI Chatbot via the "Train Your AI Chatbot" page.</p></figcaption></figure>

After clicking ![Click the "+Add with CSV" button to submit a CSV spreadsheet file containing Q\&As that your AI Chatbot will refer to.](/files/akIbcdmFWFIsRflhifkT), a pop-up window should appear.

In the ***Submit additional Q\&A*** windo&#x77;**:**&#x20;

* Drag the appropriate CSV (up to 100MB) containing the list of training questions and answers.
* Click ![Use the "Submit Additional Q\&A" window to upload a CSV spreadsheet of Q\&A pairs you want your AI Chatbot to use. Click the "+Add Q\&A" button after uploading your CSV file to officially insert your Q\&A pairs into your AI Chatbot via the "Train Your AI Chatbot" page.](/files/KwI5zBffYFMTJ0ULDhTy)

### CSV Format

<figure><img src="/files/uev6f5Vts5yc0EAjt0KS" alt="A preview of a CSV file in the form of a spreadsheet that can be uploaded into the +Add Q&#x26;A window of the Train Your AI Chatbot page when creating an AI Chatbot. Notice how Column A is delegated to a question and Column B is assigned to contain answers with no complex formatting."><figcaption><p>A preview of a CSV file in the form of a spreadsheet that can be uploaded into the +Add Q&#x26;A window of the Train Your AI Chatbot page when creating an AI Chatbot. Notice how Column A is delegated to a question and Column B is assigned to contain answers with no complex formatting.</p></figcaption></figure>

When uploading a CSV file to the *+Add Q\&A* window of the *Train Your Chatbot* page, there's no need for complex formatting. As a CSV or **comma separated values** file, you can simply upload a file containing the following:

* **Spreadsheet:** You can create a simple spreadsheet where Column A lists questions and Column B lists answers. Similar to a traditional spreadsheet, the items in Column B will answer the questions beside them in Column A. It should appear like this:

| Questions                                     | Answers |
| --------------------------------------------- | ------- |
| How many letters are in the English alphabet? | 26      |
| What color is an apple?                       | Red     |

* **CSV Plain Text:** You can upload a CSV plain text file containing header row followed by a set of data rows. Columns are separated by commas and rows are separated by line breaks.  The above table can be converted into this plain text format, and then saved as CSV:

```
Questions, Answers
How many letters are in the English alphabet?, 26
What color is an apple?, Red
```

***


# Select Integration

Enhance your AI Chatbot with new functionalities

<figure><img src="/files/1VCXUaylM6yojzsf5srl" alt="The &#x22;Select Integration&#x22; page within the AI Chatbot creation process can add new functionalities to your bot. These include Zapier Actions that connect to other applications, and Mini Course generation courtesy of Captivate Athena."><figcaption><p>The "Select Integration" page within the AI Chatbot creation process can add new functionalities to your bot. These include Zapier Actions that connect to other applications, and Mini Course generation courtesy of Captivate Athena.</p></figcaption></figure>

After the *Train Your AI Chatbot* page of the AI Chatbot creation process, you will be taken to a ***Select Integration*** page.&#x20;

Click your desired integration and click ![After selecting an integration type in "Select Integration" under Setup > AI Chatbots, you can now further customise its new capabilities.](/files/96dI0p43cRBJDaRvQKZx).

After setting up your desired integration, click ![If you made it to the "Select Integration" page of the AI Chatbot creation process, leave it be and click "Update AI Chatbot" to finish the AI Chatbot creation process.](/files/lQOdcMhZFhpj2OKmKTiS)  to finish the AI Chatbot setup.


# Copy of Select Integration

<figure><img src="/files/RywDMBHgOyt2ta6PvIqb" alt="The &#x22;Select Integration&#x22; page within the AI Chatbot creation process can assign the AI Chatbot to get user data from their conversations and store them in a selected integration platform: HubSpot, Email, or Google Sheets."><figcaption><p>The "Select Integration" page within the AI Chatbot creation process can assign the AI Chatbot to get user data from their conversations and store them in a selected integration platform: HubSpot, Email, or Google Sheets.</p></figcaption></figure>

After the *Train Your AI Chatbot* page of the AI Chatbot creation process, you will be taken to a ***Select Integration*** page. Your AI Chatbot will take relevant user data from conversations and insert those data in your chosen integration platform. These platforms require different steps before being selected as your AI Chatbot's mode of integrating user data:

{% content-ref url="/pages/AnN73kA4cFDdXPDdCTgJ" %}
[Broken mention](broken://pages/AnN73kA4cFDdXPDdCTgJ)
{% endcontent-ref %}

{% content-ref url="/pages/6JuqPl3fOhm4qOmkEDyV" %}
[Broken mention](broken://pages/6JuqPl3fOhm4qOmkEDyV)
{% endcontent-ref %}

{% content-ref url="/pages/Ox95UZD9bO0IbLQM0hH3" %}
[Broken mention](broken://pages/Ox95UZD9bO0IbLQM0hH3)
{% endcontent-ref %}

Once you're done placing your integration, click ![If you made it to the "Select Integration" page of the AI Chatbot creation process, leave it be and click "Update AI Chatbot" to finish the AI Chatbot creation process.](/files/lQOdcMhZFhpj2OKmKTiS)  to finish the AI Chatbot setup.


# Integrate HubSpot to AI Chatbot

<figure><img src="/files/oIbbfKaWxIzaYlJ1PoYM" alt="Under the &#x22;Select Integration&#x22; page, selecting &#x22;HubSpot&#x22; and clicking &#x22;Configure&#x22; will take users to a &#x22;Customize Integration&#x22; page where they have to insert their HubSpot account&#x27;s Access Token. After that, they should click &#x22;Next&#x22; to finish the integration process."><figcaption><p>Under the "Select Integration" page, selecting "HubSpot" and clicking "Configure" will take users to a "Customize Integration" page where they have to insert their HubSpot account's Access Token. After that, they should click "Next" to finish the integration process.</p></figcaption></figure>

**HubSpot** is a customer relationship management (CRM) platform designed to help businesses attract visitors, convert leads, and close customers through a unified suite of tools for marketing, sales, customer service, and content management.

This integration will automatically populate your HubSpot account with the name and email of users who ask your AI Chatbot to connect them to a Live Agent. You can then use the information for your email marketing campaigns and other sales efforts.

To integrate HubSpot into your AI Chatbot:

1. Select the HubSpot icon under "Select Integration."
2. Click ![The "Configure" button in the "Select Integration" page will let users configure the information of the platform they selected. The "Select Integration" page within the AI Chatbot creation process can assign the AI Chatbot to get user data from their conversations and store them in a selected integration platform: HubSpot, Email, or Google Sheets.](/files/BGyHsPHtcPVWdYMxfx9a).
3. Enter your **Access Token**. This is your HubSpot API Key, which you can obtain by following [these instructions](https://developers.hubspot.com/docs/guides/apps/private-apps/overview#make-api-calls-with-your-app-s-access-token).
4. Click !["Next" in the context of Select Integration > HubSpot > Configure > Customize Integration will integrate the HubSpot Access Token into the AI Chatbot. ](/files/bqHcpjZjX38JfiYrelZ0).

{% hint style="warning" %}
**Only the user's names and emails will be added to your HubSpot account**

Please note that, at this time, the Captivate Chat HubSpot Integration **only captures the user’s name and email**.&#x20;

Any future improvements, such as support for custom forms, may be added in future updates and releases.
{% endhint %}

***

Once you're done placing your integration, click ![If you made it to the "Select Integration" page of the AI Chatbot creation process, leave it be and click "Update AI Chatbot" to finish the AI Chatbot creation process.](/files/lQOdcMhZFhpj2OKmKTiS)  to finish the AI Chatbot setup.


# Integrate Email to AI Chatbot

<figure><img src="/files/hLBr1JyjYSgazxKnHjRn" alt="Under the &#x22;Select Integration&#x22; page, selecting &#x22;Email&#x22; and clicking &#x22;Configure&#x22; will take users to a &#x22;Customize Integration&#x22; page where they have to insert their email address. After that, they should click &#x22;Next&#x22; to finish the integration process."><figcaption><p>Under the "Select Integration" page, selecting "Email" and clicking "Configure" will take users to a "Customize Integration" page where they have to insert their email address. After that, they should click "Next" to finish the integration process.</p></figcaption></figure>

Captivate Chat's AI Chatbots can send you relevant user data to your **preferred email address**. When a user asks your AI Chatbot to connect them to a Live Agent, they will **send a no-reply email to the preferred email address** you provided. &#x20;

To integrate Email into your AI Chatbot:

1. Select the Email icon under "Select Integration."
2. Click ![The "Configure" button in the "Select Integration" page will let users configure the information of the platform they selected. The "Select Integration" page within the AI Chatbot creation process can assign the AI Chatbot to get user data from their conversations and store them in a selected integration platform: HubSpot, Email, or Google Sheets.](/files/BGyHsPHtcPVWdYMxfx9a).
3. Enter your **preferred email address** under "User Email"
4. Click !["Next" in the context of Select Integration > Email > Configure > Customize Integration will integrate the email address into the AI Chatbot. ](/files/bqHcpjZjX38JfiYrelZ0).

{% hint style="warning" %}
**Only the user's names and emails will be sent to your preferred email address**

Please note that, at this time, the Captivate Chat Email Integration **only captures the user’s name and email**.&#x20;

Any future improvements, such as support for custom forms, may be added in future updates and releases.
{% endhint %}

***

Once you're done placing your integration, click ![If you made it to the "Select Integration" page of the AI Chatbot creation process, leave it be and click "Update AI Chatbot" to finish the AI Chatbot creation process.](/files/lQOdcMhZFhpj2OKmKTiS)  to finish the AI Chatbot setup.


# Integrate a Google Sheet to AI Chatbot

<figure><img src="/files/15z31g2Xy1hSnTyWeOLq" alt="Under the &#x22;Select Integration&#x22; page, selecting &#x22;Google Sheets&#x22; and clicking &#x22;Configure&#x22; will take users to a &#x22;Customize Integration&#x22; page where they have to insert their Google Sheet&#x27;s Sheet ID. After that, they should click &#x22;Next&#x22; to finish the integration process."><figcaption><p>Under the "Select Integration" page, selecting "Google Sheets" and clicking "Configure" will take users to a "Customize Integration" page where they have to insert their Google Sheet's Sheet ID. After that, they should click "Next" to finish the integration process.</p></figcaption></figure>

You can also select **Google Sheets** as your AI Chatbot integration. With this selected, users who want to transition to a Live Agent will have their name and email address auto-populate the sheet named "Customers" within your Google Sheet file.&#x20;

{% hint style="danger" %}
**Your Google Sheet needs to be editable by everyone**

Before you start the integration process that connects your Google Sheet to your AI Chatbot, make sure that your selected Google Sheet has its permissions set to be editable by everyone!&#x20;

To do this, please follow the steps in [this link](https://www.youtube.com/watch?v=Dv8s4QxZlDk).&#x20;

You can also simply click the blue *"Share"* button on the upper right of your Google Sheet. Under *"General Access,"* click *"Anyone with the link"* and select *"Can edit."*&#x20;
{% endhint %}

{% hint style="danger" %}
**You need to create a "Customers" sheet first!**

Before you integrate your Google Sheet into your AI Chatbot, your selected Google Sheet needs to have its *"Sheet 1"* renamed as `Customers`.&#x20;

This is where we will send the user data gathered by your AI Chatbot.
{% endhint %}

To integrate Google Sheets into your AI Chatbot:

1. Select the Google Sheets icon under "Select Integration."
2. Click ![The "Configure" button in the "Select Integration" page will let users configure the information of the platform they selected. The "Select Integration" page within the AI Chatbot creation process can assign the AI Chatbot to get user data from their conversations and store them in a selected integration platform: HubSpot, Email, or Google Sheets.](/files/BGyHsPHtcPVWdYMxfx9a).
3. Enter your **the Sheet ID** of your preferred Google Sheets file.&#x20;
4. Click !["Next" in the context of Select Integration > Google Sheet > Configure > Customize Integration will integrate the selected Google Sheet into the AI Chatbot. ](/files/bqHcpjZjX38JfiYrelZ0).

{% hint style="info" %}
**Where is my Sheet ID?**

Your Google Sheet ID is located in the URL:&#x20;

*docs.google.ocm/spreadsheets/d/*`<this-is-the-sheet-id>` */edit?gid=0#gid=0*
{% endhint %}

{% hint style="warning" %}
**Only the user's names and emails will be sent to your Google Sheets file**

Please note that, at this time, the Captivate Chat Google Sheet Integration **only captures the user’s name and email**.&#x20;

Any future improvements, such as support for custom forms, may be added in future updates and releases.
{% endhint %}

***

Once you're done placing your integration, click ![If you made it to the "Select Integration" page of the AI Chatbot creation process, leave it be and click "Update AI Chatbot" to finish the AI Chatbot creation process.](/files/lQOdcMhZFhpj2OKmKTiS)  to finish the AI Chatbot setup.


# Finishing Touches

## Congrats, you made your AI Chatbot!

<figure><img src="/files/za4vsevlEdswEBnSmiQ3" alt="All new and existing AI Chatbots will be placed in the &#x22;My AI Chatbots&#x22; window after clicking Setup > AI Chatbots."><figcaption><p>All new and existing AI Chatbots will be placed in the "My AI Chatbots" window after clicking Setup > AI Chatbots.</p></figcaption></figure>

Once you're finished in the AI Chatbot creation process, you should see your AI Chatbot under the ***My AI Chatbot*** page.&#x20;


# Modify your AI Chatbots

Edit the parameters of your AI Chatbots

After you finish creating your AI Chatbot, you will return to the ***Setup > My AI Chatbots*** view. Your newest AI Chatbot will be displayed as the first tile from the top left of your list.&#x20;

To maintain an existing AI Chatbot, select the tile from the list provided.  You can then proceed using any of the following steps:&#x20;

***

## Click the tile or the settings

<figure><img src="/files/xD6yQ1fkeuGtsFKzvzUL" alt="Click on any AI Chatbot or the hamburger tile menu beside the AI Chatbot of your choice to access its settings (Edit, Duplicate, Delete)."><figcaption><p>Click on any AI Chatbot or the hamburger tile menu beside the AI Chatbot of your choice to access its settings (Edit, Duplicate, Delete).</p></figcaption></figure>

You can modify your AI Chatbot by first **clicking any AI Chatbot tile or by clicking the settings (** ![Click the hamburger tile menu beside the AI Chatbot of your choice to access its settings. You can edit the AI Chatbot to go through the AI Chatbot creation process, make a copy, upload new data, do testing, or delete it entirely.](/files/KST6nVMhsZouA9SL5Nug) **) ,** and then choosing an action you want accomplish:&#x20;

* **Edit:** Adjusts all parameters of the AI Chatbot.
* **Duplicate:** Creates a copy of the AI Chatbot.
* **Delete:** Permanently deletes the AI Chatbot.


# Create an Agent Group

Create an Agent Group that routes conversations to the correct AI Chatbot

You can use the Captivate platform to create an **Agent Group**. This is a combination of AI Chatbots (Agents) you can attach to Channels. With Captivate's AI Router, an Agent Group connects users to the appropriate AI Chatbot within its system by solely relying on natural language queries.

{% hint style="info" %}
**SUMMARY**

Creating an Agent Group is straightforward. You can do this in a few steps:

1. Click the **Agent Group** button
2. In the list of Agent Groups, click *+Create New Group* to start the process.
3. **Provide basic information:** Provide the name of your Agent Group.
4. **Select Agents:** Click *+Add Agent* to add an AI Chatbot inside your Agent Group.
5. **Set up Agent:** For every Agent you add into the Agent Group:
   1. **Select the AI Chatbot** you need from your list of existing chatbots
   2. Name the **Model Provider** (e.g., OpenAI, Anthropic, etc.)
   3. Give a **Description** of what this specific Agent does
   4. Give an E**xample Query,** or the kind of message the user needs to type in order to get routed into the specific Agent
      {% endhint %}

To start creating an Agent Group, proceed with this next step:&#x20;


# Setting Up

Give your Agent Group a name before setting up its parameters

<figure><img src="/files/ZmWsFSzgEggkJQLT5js2" alt="The &#x22;Agent Group (Beta)&#x22; button is accessible in the left-hand side of the Captivate platform. Click this to access the Agent Group page."><figcaption><p>The "Agent Group (Beta)" button is accessible in the left-hand side of the Captivate platform. Click this to access the Agent Group page.</p></figcaption></figure>

Before you create an Agent Group, you have to access its main menu.

From the left-hand side of the Captivate platform, click **Agent Group (Beta)**.&#x20;

{% hint style="danger" %}
**Agent Groups are still in beta!**

In order to access Agent Groups, you need to activate **Developer Mode** in your settings:

1. Click your profile picture on the upper-right of the Captivate platform.
2. Click **Account Settings**.
3. Enable **Developer Mode**.
4. Refresh the homepage.
   {% endhint %}

<figure><img src="/files/HlZY1vMyJkvKnianEf3s" alt="The &#x22;Agent Groups&#x22; page gives a view of the Total Groups in the platform and the Total Agents used across them. You may click &#x22;+Create Agent Group&#x22; to start creating your own Agent Groups."><figcaption><p>The "Agent Groups" page gives a view of the Total Groups in the platform and the Total Agents used across them. You may click "+Create Agent Group" to start creating your own Agent Groups.</p></figcaption></figure>

Within the **Agent Groups** page, you will see:

* The **Total Groups** or the total number of Agent Groups created in the platform
* The **Total Agents** used across these Agent Groups&#x20;

To start creating your Agent Group, click ![You may click "+Create Agent Group" to start creating your own Agent Groups.](/files/RfvtOUaVzuvkQeaBEbfC)

{% hint style="info" %}
**You can use the same Agents (AI Chatbots) in different Agent Groups**

Depending on the kind of AI Chatbots you have set up, you can attach them to different Agent Groups.&#x20;

For example, a unified **Company Information** bot can be attached to Agent Groups about Sales, Marketing, or Operations. Such configurations could look like:

* **Sales Group:** Company Information, Sales Information
* **Marketing Group:** Company Information, Product Guide, Marketing Collaterals
* **Operations:** Company Information, Service Guide
  {% endhint %}


# Create New Agent Group

Set up your Agent Group within the Create New Agent Group popup.

<figure><img src="/files/z4UOrOHDf2M2yHHpj5Fb" alt="After clicking &#x22;+Create New Agent Group&#x22; a &#x22;Create New Agent Group&#x22; popup window will appear. This will initially appear empty except the option to fill out Group Name, and clicking &#x22;+Add Agent&#x22; will start populating the popup with the option to add Agents."><figcaption><p>After clicking "+Create New Agent Group" a "Create New Agent Group" popup window will appear. This will initially appear empty except the option to fill out Group Name, and clicking "+Add Agent" will start populating the popup with the option to add Agents.</p></figcaption></figure>

When you click *+Create New Agent Group*, this **Create New Agent Group** popup will appear.

Fill out the **Group Name**, which will represent your Agent Group. This will be the name you have to locate if you want to use the Agent Group as an AI Chatbot in your Channels.

## Add Agent

In order to add a new AI Chatbot into your Agent Group, click ![Click "+Add Agent" within the "Create New Agent Group" to start adding AI Chatbots as Agents in the Agent Group you are currently working on](/files/ioY13Wfj3q3VkrXjRcRL)

This will expand the ***Create New Agent Group*** popup to reveal a new interface.

<figure><img src="/files/Fk6UnkIekWojwrLTexnz" alt="Click &#x22;+Add Agent&#x22; to start adding agents to your Agent Group in the &#x22;Create New Agent Group&#x22; popup. Click &#x22;+Add Agent&#x22; as many times as you need to add as many AI Chatbots in your Agent Group as needed, provided you fill out the necessary information."><figcaption><p>Click "+Add Agent" to start adding agents to your Agent Group in the "Create New Agent Group" popup. Click "+Add Agent" as many times as you need to add as many AI Chatbots in your Agent Group as needed, provided you fill out the necessary information.</p></figcaption></figure>

After clicking ***+Add Agent***, the popup expands to reveal more fillable information. Please provide the following:

* **Select Chatbot:** Choose the AI Chatbot you want to add into the Agent Group. It has to be a pre-existing AI Chatbot you already created.
* **Agent Name:** Give your AI Chatbot an Agent Name to be used in the context of this Agent Group.
* **Model Provider (Optional):** Give a Model Provider of the AI Chatbot you've chosen for easy tracking in your dev team - this can be OpenAI, Anthropic, etc.
* **Description:** Describe the function of your AI Chatbot within this Agent Group. How will it help users compared to your other bots inside this Agent Group?
* **Example Queries:** Add examples of chats from users that this AI Chatbot will normally answer. This will teach the Agent Group to start routing users to this AI Chatbot if they spot questions that follow the pattern of your queries.&#x20;

Repeat the process by clicking ***Add Agent*** to add as many AI Chatbots as your Agent Group needs.

## Finish your Agent Group setup

When done, click ![Finish your Agent Group set up by clicking "Create Group" after filling out everything inside the "Create New Agent Group" popup](/files/MozGYesSafMM2VWdMlDD)


# View and Modify Agent Groups

Edit Agent Groups you already created inside the Agent Group window

<figure><img src="/files/iPZgQjsaXS414w20CvBK" alt="The &#x22;Agent Groups&#x22; page gives a view of the Total Groups in the platform and the Total Agents used across them. You may click &#x22;+Create Agent Group&#x22; to start creating your own Agent Groups."><figcaption><p>The "Agent Groups" page gives a view of the Total Groups in the platform and the Total Agents used across them. You may click "+Create Agent Group" to start creating your own Agent Groups.</p></figcaption></figure>

The ***Agent Groups*** window contains a list of all Agent Groups you created. You can modify Agent Groups from within this interface.

## View inside the Agent Group window

<figure><img src="/files/TtkSnyOhLNaL3IyXSQj5" alt="Click the drop-down icon beside the name of an Agent Group to expand it within the &#x22;Agent Groups&#x22; window. It will reveal the overview of the Agents inside the group - each of their Descriptions, Providers, Example Queries. You can also edit the Agent Group or delete it. "><figcaption><p>Click the drop-down icon beside the name of an Agent Group to expand it within the "Agent Groups" window. It will reveal the overview of the Agents inside the group - each of their Descriptions, Providers, Example Queries. You can also edit the Agent Group or delete it.</p></figcaption></figure>

Flag an Agent Group for editing by clicking the drop-down icon beside its name. This will mark the Agent Group as **Selected**.&#x20;

It reveals a quick overview of the Agents inside the Agent Group.&#x20;

You also have two options:

* **Edit:** Click the pencil icon to go to an editing interface similar to ***+Create New Agent Group***.
* **Trash:** Click the garbage icon to delete the Agent Group.

## View Agent Group as its own window

<figure><img src="/files/uqJNcp5BdOlrhFn8TlaD" alt="When you click an Agent Group in the &#x22;Agent Groups&#x22; window, it brings you to its own page. It will give an overview of all Agents inside them, alongside their Description, Model Provider, Example Queries, and their Agent Index."><figcaption><p>When you click an Agent Group in the "Agent Groups" window, it brings you to its own page. It will give an overview of all Agents inside them, alongside their Description, Model Provider, Example Queries, and their Agent Index.</p></figcaption></figure>

Click an Agent Group to view it as its own window.

It will reveal the following:

* **Quick Info:** A quick overview of the entire Agent Group, as well as its
  * Group ID
  * Total Agents
  * Service Status: If the bot is Active or Inactive
* **Agents:** The overview of every Agent inside the Agent Group, as well as their
  * Description
  * Model Provider
  * Example Queries
  * Agent Index: This is the order from which the Agent was added into the Agent Group

## Edit the Agent Group

<figure><img src="/files/QcXoM94NuTH9n6eOmlFt" alt="Click the Edit icon to open the &#x22;Edit Agent Group&#x22; window to start modifying information, and adding agents to your Agent Group. Click &#x22;+Add Agent&#x22; as many times as you need to add as many AI Chatbots in your Agent Group as needed, provided you fill out the necessary information."><figcaption><p>Click the Edit icon to open the "Edit Agent Group" window to start modifying information, and adding agents to your Agent Group. Click "+Add Agent" as many times as you need to add as many AI Chatbots in your Agent Group as needed, provided you fill out the necessary information.</p></figcaption></figure>

After clicking the pencil icon, you will be brought to the ***Edit Agent Group*** window.&#x20;

It appears exactly like the ***Create New Agent Group*** window, but you can now modify existing fields you filled out in your Agent Group.

When done with your changes, click ![Finish updating your Agent Group in the "Edit Agent Group" window by clicking the "Update Group" button.](/files/UY50ammhN21GQQItFedz)


# Create a Chat Flow

Bring your AI Assistants, Live Chats, and Channels together in one system

Use a **Chat Flow** to unite AI Chatbots, Live Chats, and Channels into one seamless interface. Once you set up a Chat Flow, you can easily modify all of its components - no need to use many apps!&#x20;

{% hint style="info" %}
**SUMMARY**

Creating a Chat Flow takes a few clicks. The steps in creating a Chat Flow will only vary depending on the kind of Channel and Live Chat you want to use. In general, the steps are:

1. **Set up your Chat Flow:** Give your Chat Flow a name. This is for internal purposes, so you can find your Chat Flow easily when you have many of them in Captivate Chat.
2. **Choose your AI Chatbot:** In *Step 1: AI Chatbot,* you can choose an existing AI Chatbot or make one from scratch.
3. **Choose your Channel:** In *Step 2: Channel*, you will choose a Channel where you want your AI Chatbot to appear. This will have different steps depending on the Channel chosen and have separate instructions how to set up your Chat Flow's public name and relevant connections.
4. **Choose your Live Chat service:** In *Step 3: Live Chats*, you will choose what Live Chat service your AI Chatbot will connect to if a customer asks for an agent from your team.&#x20;
5. **Set up your Live Chat service:** Connect Captivate Chat to the Live Chat service you have chosen in *Step 3*. It will have different instructions per service, but this usually involves installing a service-exclusive Captivate Chat app.&#x20;
   {% endhint %}


# Setting Up

<figure><img src="/files/d1xRExWpfmsCqpfBBWqA" alt="Under Setup > Chat Flows, users can see their existing Chat Flows as well as a +Chat Flow button to create their own Chat Flow."><figcaption><p>Under Setup > Chat Flows, users can see their existing Chat Flows as well as a +Chat Flow button to create their own Chat Flow.</p></figcaption></figure>

Before creating your actual Chat Flow, you need to set it up in the Captivate Chat platform.&#x20;

Under the ***Setup > Chat Flow** view*, click ![The "+Chat Flow" button will begin the process of setting up a Chat Flow. It will prompt users to give a name for the Chat Flow . The name provided via "+Chat Flow" is only for internal use and won't be seen by users.](/files/WA6JdV4UbJJRPyjKxkuQ).&#x20;

A pop-up window should appear. Under **Create your Chat Flow**, fill up the following:

* **Chat Flow Name:** Give your Chat Flow a name. It's recommended that you name it based on the specific process you want to fulfill. This name will be used for internal use only. You can give your Chat Flow an official name depending on the Channel you've chosen.

Click ![The blue "Create Chat Flow" shows in the prompt that asks users to type their Chat Flow name. This appears after they click "+Chat Flow." Clicking "Create Chat Flow" creates an empty Chat Flow that needs an AI Chatbot, a Channel, and a Live Chat integration.](/files/L6c372v3rGIq3w2nBmei) when you're finished.

<figure><img src="/files/ePUwVwg8lsCDDXgiQKaJ" alt="You have to name your Chat Flow before you start modifying its parameters"><figcaption><p>You have to name your Chat Flow before you start modifying its parameters</p></figcaption></figure>


# AI Chatbots

Select the AI Chatbot to accompany your Chat Flow

<figure><img src="/files/AdJKe4zf7jKUUT5YtVvk" alt="After setup, the &#x22;My AI Chatbots&#x22; window is the first step of creating a Chat Flow. In the context of Chat Flow creation, users can select an existing AI Chatbot or create a new one from scratch by clicking the &#x22;+AI Chatbot&#x22; button."><figcaption><p>After setup, the "My AI Chatbots" window is the first step of creating a Chat Flow. In the context of Chat Flow creation, users can select an existing AI Chatbot or create a new one from scratch by clicking the "+AI Chatbot" button.</p></figcaption></figure>

Once you name your Chat Flow, you will be taken to ***Step 1: AI Chatbot*****.**&#x20;

Select the AI Chatbot you want to be involved in this particular Chat Flow. Think of it as choosing the AI Chatbot that will interact with your audiences through your platform (your website or social media platform, to name a few). &#x20;

You can proceed with *Step 1: AI Chatbots* in two ways:

## Create an AI Chatbot

If players create an AI Chatbot from scratch while making a Chat Flow, the AI Chatbot they will create will automatically be assigned to the Chat Flow they are setting up.&#x20;

Click ![The "+AI Chatbot" button inside the "Step 1: My AI Chatbots" window of creating a Chat Flow will take users to the steps of creating an AI Chatbot that will automatically be assigned to the Chat Flow.](/files/U57dEeHzJG0MFnTJh5Nb), and you will be taken to the same steps of this page:&#x20;

{% content-ref url="/pages/qj0en0fKQZYaeiNnVhqE" %}
[Create an AI Chatbot](/start-creating/create-an-ai-chatbot)
{% endcontent-ref %}

## Select an existing AI Chatbot

Click the Chatbot you want to use. Make sure it is fully functional.&#x20;

If you want to check its details, click ![If you select an existing AI Chatbot during the "Step 1: My AI Chatbots" of the Chat Flow set up process, you can click the "Next: Import your Information" button to upload data to be ingested. ](/files/p9NpMOD1I8w92PE5Qd4X). It will take you to the same steps of this page:

{% content-ref url="/pages/PIXeGBDLLz85r7jdkPWF" %}
[Import Your Own Information](/start-creating/create-an-ai-chatbot/import-your-own-information)
{% endcontent-ref %}

## Next steps

Once you've made your choice, you can move forward by either:

### If you created a new AI Chatbot

<figure><img src="/files/1QnaOfG5NpjVjtRjMn2Y" alt=""><figcaption></figcaption></figure>

After going through the steps of [#create-an-ai-chatbot](#create-an-ai-chatbot "mention"), you will end up in the ***Select Integration*** view. When finished with your Integrations, click ![](/files/VPwNZ51WmnauF4VN5dOk)

### If you selected an existing AI Chatbot

<figure><img src="/files/Pavapk2Y83ONqNNtApdi" alt=""><figcaption></figcaption></figure>

After selecting an existing AI Chatbot, click ***Step 2: Channel***, as seen on the left side of the screen.

&#x20;![](/files/WyGUyD8hKBEe5kT1LSjw)

***


# Select Channel

Bring your AI Chatbots, Live Chats, and Channels together in one system

<figure><img src="/files/3gEOvMdZdM9Fdt2Zvy5k" alt="The &#x22;Select Channel&#x22; window inside &#x22;Step 2: Channel&#x22; contains the currently available Channels in Captivate. Your Channel of choice will be highlighted blue. Click &#x22;Next&#x22; to proceed to the specific connection process "><figcaption><p>The "Select Channel" window inside "Step 2: Channel" contains the currently available Channels in Captivate. Your Channel of choice will be highlighted blue. Click "Next" to proceed to the specific connection process </p></figcaption></figure>

<figure><img src="/files/McsSrVpRdh128h3MGzym" alt="The &#x22;Select Channel&#x22; window inside &#x22;Step 2: Select Channel&#x22; contains the currently available Channels in Captivate Chat. Your Channel of choice will be highlighted blue. Click &#x22;Next&#x22; to proceed to the specific connection process "><figcaption><p>The "Select Channel" window inside "Step 2: Select Channel" contains the currently available Channels in Captivate Chat. Your Channel of choice will be highlighted blue. Click "Next" to proceed to the specific connection process </p></figcaption></figure>

After selecting the active Chatbot in your Chat Flow, it's time to choose your **Channel** in ***Step 2: Select Channel***. This is where your users will encounter your AI Chatbot.&#x20;

We are offering different Channel Integrations into your Chat Flow, with different instructions how to set up each. They are accessible via [Select Channel](/start-creating/create-a-chat-flow/select-channel)or in these pages:

{% content-ref url="/pages/VB3qJyFYbX44nhcefff7" %}
[Channel: Web Chat](/start-creating/create-a-chat-flow/select-channel/channel-web-chat)
{% endcontent-ref %}

{% content-ref url="/pages/hsZRSxaPmTNLbzVlWbwI" %}
[Channel: Facebook](/start-creating/create-a-chat-flow/select-channel/channel-facebook)
{% endcontent-ref %}

{% content-ref url="/pages/fPCLtWUzP3DUoAXq08Cp" %}
[Channel: Instagram](/start-creating/create-a-chat-flow/select-channel/channel-instagram)
{% endcontent-ref %}

{% content-ref url="/pages/QMczwa6JfAUtSYPXR2hz" %}
[Channel: WhatsApp](/start-creating/create-a-chat-flow/select-channel/channel-whatsapp)
{% endcontent-ref %}

{% content-ref url="/pages/cvp7nqUwVHmXNEPyigZJ" %}
[Channel: Full Chat](/start-creating/create-a-chat-flow/select-channel/channel-full-chat)
{% endcontent-ref %}

{% content-ref url="/pages/NFOi0B9hwL6xfZHvj0QB" %}
[Channel: Custom Channel](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel)
{% endcontent-ref %}

{% hint style="info" %}
**Different users can visit your Channels!**

While your AI Chatbots are built to respond to any user when they access your Channel, remember that **different kinds of users can interact with your AI Chatbot**. When creating a Chat Flow for your AI Chatbot, consider these types of users:

* **Customers:** These are users who want to avail your service and/or products and may need your AI Chatbot to help them choose the right offerings.
* **Team:** These are members of your Team who interact with the AI Chatbot for the purposes of aiding internal operations. Interactions include directing the AI Chatbot to connect users to other agents, and the like.
* **Other Parties:** These are other types of users who might interact with your AI Chatbot for other purposes. These can include marketers who are checking your website in the hopes of a partnership, as well as potential stockholders and investors.
  {% endhint %}

Once done, click either ![](/files/KcO4VAhTtwRuKpbSYDpo) or the ***Step 3: Live Chats*** button on the left of the screen.

<figure><img src="/files/tHQzyel6AOco5KDNaJuq" alt=""><figcaption></figcaption></figure>


# Channel: Web Chat

Connect your AI Assistant to your website

<figure><img src="/files/pBQ8ACGJuPJG7eEHgXBq" alt="In the Chat Flow creation process, after selecting your AI Chatbot in &#x22;Step 1: AI Assistant,&#x22; select &#x22;Web Chat&#x22; in &#x22;Step 2: Select Channel&#x22; to start the Web Chat creation process."><figcaption><p>In the Chat Flow creation process, after selecting your AI Chatbot in "Step 1: AI Assistant," select "Web Chat" in "Step 2: Select Channel" to start the Web Chat creation process.</p></figcaption></figure>

After ***Select Channel > Web Chat***, you will be taken to the ***Configure Web Chat*** view. This is where you will set up your Chatbot to make it compatible with your website.&#x20;

{% hint style="info" %}
**SUMMARY**

Creating a Web Chat as a Chat Flow involves these steps:

1. **Choose Web Chat:** In *Step 2: Select Channel*, choose "Web Chat." This brings you to the *Configure Web Chat* window.
2. **Add preset text:** Use the *Text Options* to modify the Web Chat's public name and default message.
3. **Add colors:** Use the *Color Options* to change the overall color palette of your Web Chat.
4. **Change images:** Use the *Image Options* to personalize your Web Chat further with images, logos, and headers.&#x20;
5. **Set a schedule:** Use the *Working Hours* to select times of the day and days of the week that the Web Chat will be active.
6. **Copy the Web Chat Embed Code:** The *Embed Web Chat* will provide a working code that you can give to your web administrator for implementation in your website.
   {% endhint %}

***

## Configure Web Chat

### Text Options

<figure><img src="/files/rhXEPFLek8JcN6SLFpUw" alt="A Web Chat is edited through the &#x22;Configure Web Chat&#x22; page. The &#x22;Text Options&#x22; lets users edit the basic components of the Web Chat before it&#x27;s interacted with by customers."><figcaption><p>A Web Chat is edited through the "Configure Web Chat" page. The "Text Options" lets users edit the basic components of the Web Chat before it's interacted with by customers.</p></figcaption></figure>

in ***Text Options***, you can customize the basic text that appears with your Chatbot once it becomes a Web Widget or an In Page bot. This portion has the following components:

* **Title:** This is the "main greeting" that the AI Chatbot will provide before starting a conversation.
* **Group Name:** This is the "public name of the Chatbot. You can name this after yourself, your team, or your company. In the image above, its name is *"Captivate Chat Test Widget*&#x20;
* **Widget Text Description:** This is the invitational message your Chatbot reveals when users click it for the first time.&#x20;

### Color Options

<figure><img src="/files/iLAMeaQAiOMTwA5lxguI" alt="&#x22;Color Options&#x22; under the &#x22;Configure Web Chat&#x22; page lets users customize the Web Chat&#x27;s basic color palette assigned to its visual components. This doesn&#x27;t contain the icons and uploadable assets of the Web Chat."><figcaption><p>"Color Options" under the "Configure Web Chat" page lets users customize the Web Chat's basic color palette assigned to its visual components. This doesn't contain the icons and uploadable assets of the Web Chat.</p></figcaption></figure>

In ***Color Options***, you can customize how your AI Chatbot appears in your website using a wide array of color options:

* **Primary Color**
* **Bubble Background** (User, Bot, Agent)
* **Chat Text** (User, Bot, Agent)
* **Chat Buttons** (Background, Text)

{% hint style="info" %}
**Fit your Web Widget colors to your branding!**

Switch up your Web Widget colors to match your branding. Select the square icon beside the hexcodes to open a color palette where you can choose your preferred colors.&#x20;
{% endhint %}

### Image Options

<figure><img src="/files/GKnR2RVLk75VQJxfHhsk" alt="In &#x22;Configure Web Chat&#x22; page, the &#x22;Image Options&#x22; is the place where users can upload assets and icons for their Web Chat."><figcaption><p>In "Configure Web Chat" page, the "Image Options" is the place where users can upload assets and icons for their Web Chat.</p></figcaption></figure>

In ***Image Options***, customize your Chatbot further with options that add "personality" to them. These include:

* **AI Chatbot Avatar:** This is how your Chatbot appears in the Web Widget.
* **Widget Icon:** This is how your Chatbot appears as an icon before expanding into a chat box. It can be the same icon as your AI Chatbot Avatar.&#x20;
* **AI Chatbot Business Image:** This represents the icon or logo of your branding or business.&#x20;
* **AI Chatbot Chat Header Image:** This is the unique background that comes with your AI Chatbot Avatar.

{% hint style="info" %}
**Use high-quality resources**

Since your Chatbot is an extension of your branding, it's important to use high-quality resources such as images for elements such as your AI Chatbot Avatar and Business Image.
{% endhint %}

### Other Options

<figure><img src="/files/r3Xl1pM5ySuivdcpF5sJ" alt="In &#x22;Configure Web Chat&#x22; page, the &#x22;Other Options&#x22; tab lets you add more customization options to your Web Chat, such as  what text to put on certain cues and buttons in your Web Widget or In Page bot."><figcaption><p>In "Configure Web Chat" page, the "Other Options" tab lets you add more customization options to your Web Chat, such as  what text to put on certain cues and buttons in your Web Widget or In Page bot.</p></figcaption></figure>

The ***Other Options*** section allows you to customize your Web Chat even further with other labelling and text options for other components of the Web Widget or In Page bot's appearance. These mostly deal with the **text to appear for functionalities that state:**

* **Text sent by:** Text to appear to indicate who sent the message.
* **Text download transcript:** Text to appear on the hyperlink that users will click to download the transcript.
* **Text today:** Text to appear to state the date today.
* **Text chat to person:** Text to appear on the hyperlink that initiates the Live Chat process.
* **Text send a message:** Text to appear on the button that sends the message.
* **Text start:** Text that appears to start the conversation.
* **Text is always active:** Text that appears to indicate the bot is always active.
* **Text is processing:** Text that appears to indicate the bot is processing a response.

There are also checklists where you can set the Web Chat to:

* **Hide AI Chatbot Avatar**
* **Hide File Attach Button**
* **Hide Business Image**
* **Hide Emoji Button**
* **Enable Full Screen**

### Working Hours

<figure><img src="/files/NJHpMzx5jFGFzbUL7kiL" alt="In &#x22;Configure Web Chat&#x22; page, the &#x22;Working Hours&#x22; section lets users assigns days of the week and hours of the day that the Web Widget will be active and available for interaction."><figcaption><p>In "Configure Web Chat" page, the "Working Hours" section lets users assigns days of the week and hours of the day that the Web Widget will be active and available for interaction.</p></figcaption></figure>

In ***Working Hours***, determine your Chatbot's working hours. You can choose its **Start Time** and **End Time**, and specific days of the week you want it to function. Here are your main considerations:

* **Disable Working Hours:** Toggling ![Tick the "Enable Work Hours" toggle to restrict the Web Widget into appearing on certain times of the day and days of the week. Toggle it off to make it available 24/7.](/files/9dMXK86WiB1FKGvuOdXW) off means the Web Widget won't follow a schedule and **provide 24/7 coverage**. This is perfect if your Web Widget is designed solely to answer questions and not connect users with live agents.
* If you want your Chatbot to connect users to Live Agents, try to set the Chatbot's schedule to match that of your team's for a more seamless experience.

{% hint style="info" %}
**You can keep your Web Widget live 24/7 even with work hours toggled**

If you don't want to toggle *"Enable Work Hours,"* you can still keep your Web Widget live indefinitely. You can do this by adjusting the "Start Time" and "End Time" to 00:00.&#x20;
{% endhint %}

***

### Embed Code

<figure><img src="/files/T5APYE5cip1wTTv0V9Hi" alt="After modifying all options in &#x22;Configure Web Chat&#x22; page, users will see &#x22;Embed Web Widget.&#x22; This has the code that Web Administrators need to put in the user&#x27;s website for the Web Chat to appear as a Web Widget or In Page."><figcaption><p>After modifying all options in "Configure Web Chat" page, users will see "Embed Web Widget." This has the code that Web Administrators need to put in the user's website for the Web Chat to appear as a Web Widget or In Page.</p></figcaption></figure>

After configuring your Web Chat, it becomes available for deployment with code provided in the ***Embed Code*** section. It has two variants:

* **Web Widget:** This is the traditional form of AI Chatbots in websites, where you click an icon that expands into a conversation window.
* **In Page:** This is an alternate version of the AI Chatbot deployment where you can use it directly from within your website.

#### Embed as Web Widget

<figure><img src="/files/jT7qGoJzSi6KMa2YEwwD" alt="Pasting the code from the &#x22;Embed Web Widget&#x22; stage of the &#x22;Configure Web Chat&#x22; page into your HTML will give your webpage a Web Widget AI Chatbot. You have to click their icon on the lower-right portion of the screen for the interface to appear."><figcaption><p>Pasting the code from the "Embed Web Widget" stage of the "Configure Web Chat" page into your HTML will give your webpage a Web Widget AI Chatbot. You have to click their icon on the lower-right portion of the screen for the interface to appear.</p></figcaption></figure>

Using the HTML code from the "Embed Web Widget" stage will give your webpage access to a **traditional web widget**. This takes the form of an icon on the lower left of your screen that transforms into a chat when clicked.&#x20;

These traditional web widgets are often used as customer assistants in most websites that provide products and services.

The ***Embed Web Widget*** section has this code:

{% hint style="info" %}
**Traditional Embed Web Widget HTML Code:**

\<script src="<https://widget.prod.captivat.io/captivate.min.js>">\</script>\
&#x20; \<script>\
&#x20;  function callWidget(data) {\
&#x20;   Captivate.init({\
&#x20;    apiKey: "YOUR\_API\_KEY\_IS\_HERE",\
&#x20;   )}\
&#x20;  }\
&#x20;  callWidget();\
&#x20; \</script>
{% endhint %}

Please take note that `apiKey: "`**`YOUR_API_KEY_IS_HERE`**`"` contains your Web Widget's API Key, which you can use in other Captivate Chat features such as full screen embeds and potential future additions.&#x20;

#### In Page

<figure><img src="/files/5C8G0fTcOsAYpZBV6U6z" alt="To access a full screen version of the AI Chatbot, add the desired Web Widget API into the full screen iframe code from the &#x22;Full Screen Embeds&#x22; section of the Captivate Chat Manual. "><figcaption><p>To access a full screen version of the AI Chatbot, add the desired Web Widget API key into the full screen iframe code from the "Full Screen Embeds" section of the Captivate Chat Manual. </p></figcaption></figure>

Alternatively, users can also insert their Web Widget Chat Flows into their websites as **full screen embeds**. Unlike traditional web widgets that take the form of an icon that expands into an AI Chatbot, a full screen embed takes up the size specified in a special `<iframe>` code.

Full screen embeds are perfect for websites that want to have a dedicated page where users can interact with AI Chatbots.&#x20;

To transform your Web Widget Chat Flow into a full screen embed, simply copy this code:

{% hint style="info" %}
**Full Screen Embed HTML Code:**

\<iframe\
&#x20;  src="<https://your-deployed-url/?apiKey=YOUR_API_KEY>"\
&#x20;  width="100%"\
&#x20;  height="100%"\
&#x20;  frameborder="0"\
&#x20;  allow="clipboard-write"\
\>\</iframe>
{% endhint %}

When modifying this `<iframe>` code, take note of these things:

1. Replace [**`your-deployed-url`**](https://your-deployed-url/?apiKey=YOUR_API_KEY) with the link of the webpage where you want to deploy the full-screen widget.
2. Replace **`YOUR_API_KEY_HERE`** with the API key of your Web Widget, as seen in the "Embed Web Widget" stage of the "Configure Web Widget" page.
3. Ensure the `allow="clipboard-write"` attribute is included if you need to enable clipboard functionality within the widget.
4. Ensure the `width` and `height` attributes are at 100% to fit the widget into your layout appropriately.

{% hint style="warning" %}
**Give your HTML embed code to your Web Administrator**

Make sure that your embed is pasted **before the closing \</body> tag** on pages of your website where you want the AI Assistant to show up. Your Web Administrator should know how to make this work.&#x20;
{% endhint %}

***

## You're all set!

Doing all the steps above should get your Chatbot ready to be used with a Web Widget.


# Preview your Web Widget

After creating your Web Widget, you can preview how it looks like right from the Captivate Chat platform!&#x20;

***

### Accessing your Web Widget

<figure><img src="/files/inp8BAeE7A27Y4lGVdu2" alt="After creating a Web Widget Chat Flow, go to Setup > Chat Flows in Captivate Chat. Look for your new Web Widget Chat Flow. It should say &#x22;Web Chat&#x22; under the Channel column."><figcaption><p>After creating a Web Widget Chat Flow, go to Setup > Chat Flows in Captivate Chat. Look for your new Web Widget Chat Flow. It should say "Web Chat" under the Channel column.</p></figcaption></figure>

From your list of Chat Flows, hover your cursor over the Web Chat icon. It should have two buttons:

* **Web Chat Preview:** Click the eye ![](/files/hsHaNDqknKfriAaWPFZg) symbol to preview your Web Chat.
* **Web Chat Widget Code:** Click the code ![](/files/IGJ88bqgC5XpI58csEXS) symbol to get your Web Chat's Widget Code&#x20;

***

### Widget Code

<figure><img src="/files/5knX7R9xTWrASgCxQ6Em" alt=""><figcaption><p>The Widget Code window is seen after clicking the code icon (the "&#x3C;>" sign) under the Channel column of your Web Chat Chat Flow. It shows the code of your Web Chat that you can give to your Web Administrator, as well as a "View Widget" button to see a live preview of your Web Widget in a sample webpage.</p></figcaption></figure>

Access your Web Chat's Widget Code by clicking the code ![](/files/IGJ88bqgC5XpI58csEXS) icon. You can toggle between the Web Widget code and the In Page code.

This is the same Widget Code that appears in the final step of [Channel: Web Chat](/start-creating/create-a-chat-flow/select-channel/channel-web-chat) instructions.&#x20;

{% hint style="warning" %}
**Give the Widget Code to your Web Administrator!**

If you want your web widget to appear on your live website, you must copy this Widget Code and give it to your Web Administrator.
{% endhint %}

***

### Widget Preview

<figure><img src="/files/EK7pMD1FosKHjJXKVfg3" alt="The Widget Preview shows a live preview of a Web Widget in a sample webpage within Captivate Chat. "><figcaption><p>The Widget Preview shows a live preview of a Web Widget in a sample webpage within Captivate Chat. </p></figcaption></figure>

When you click the eye ![](/files/hsHaNDqknKfriAaWPFZg) symbol, your browser will open a new window that says ***Captivate Chat - Widget Preview**.*&#x20;

This is the place where you can check how your Web Widget looks like even before you plug in the code to your actual website.&#x20;

Notice how your Widget Icon is on the lower right of the screen.&#x20;

***

### Testing the Web Widget

<figure><img src="/files/tf9XN4rHkuXXyvNzxgTW" alt="Clicking your web widget icon on the lower-right of the Web Widget Preview webpage shows your Web Widget. Click the &#x22;Start&#x22; button to start interacting with it."><figcaption><p>Clicking your web widget icon on the lower-right of the Web Widget Preview webpage shows your Web Widget. Click the "Start" button to start interacting with it.</p></figcaption></figure>

Clicking your Widget Icon reveals a prototype of the Chatbot.&#x20;

This prototype is fully functional, with both your set visual settings and included AI training. You can ask it questions and see its responses. Thanks to this process, you can see all aspects of your Chatbot before it's even deployed to your system.&#x20;

***

### Customizing the Web Widget Preview

<figure><img src="/files/VomYobG8YZuVhmk2rPVi" alt="Click the &#x22;Page Settings&#x22; button on the upper right of the Web Widget Preview webpage. This shows a new window called Page Settings where you can share your page URL, get an API key, change the background, and even hide the welcome banner for a more immersive experience."><figcaption><p>Click the "Page Settings" button on the upper right of the Web Widget Preview webpage. This shows a new window called "Page Settings" where you can share your page URL, get an API key, change the background, and even hide the welcome banner for a more immersive experience.</p></figcaption></figure>

Clicking the ![Click the "Page Settings" button on the upper right of the Web Widget Preview webpage. This shows a new window called Page Settings where you can share your page URL, get an API key, change the background, and even hide the welcome banner for a more immersive experience.](/files/GTDAl3S5sgFU9Hiq0GkA) on the upper right of the preview site will reveal more customization options. With this new window, you can:

* **Share URL:** Copy the URL of this Widget Preview so you can share it with your teammates.
* **API Key:** The API Key of the Web Widget.
* **Background:** You can customize the Background of this Widget Preview.&#x20;

***

### Background

<figure><img src="/files/HmQoOM1DANdUC7uFIHuW" alt="The &#x22;Background Type&#x22; section of the &#x22;Page Settings&#x22; window of the Web Widget Preview webpage can let users paste a URL of their choice or upload an image that can act as a static sample background for their Web Widget."><figcaption><p>The "Background Type" section of the "Page Settings" window of the Web Widget Preview webpage can let users paste a URL of their choice or upload an image that can act as a static sample background for their Web Widget.</p></figcaption></figure>

Under ***Select Background Type***, you can choose either a **Web** or **Image** as the source of your Background Asset:

* **Web:** You can enter any URL to "copy" its background. This reveals how the Web Widget can appear in a live website.
* **Image:** You can upload an image that becomes the background of the Web Widget. This is useful if you're still designing your website. Its resolution should be 1980 x 1080.

<figure><img src="/files/Awu0CbpCF8WxRw8HZ8Ik" alt="The Web Widget Preview webpage changes into the static background of your choice after uploading an image or inserting a URL in the &#x22;Background Type&#x22; section. "><figcaption><p>The Web Widget Preview webpage changes into the static background of your choice after uploading an image or inserting a URL in the "Background Type" section. </p></figcaption></figure>

Click ![After uploading an image in the "Background Type" of the "Page Settings" of the Web Widget Preview webpage, click "Apply" in "Page Settings" to apply the changes.](/files/cQF4JIe0OpKHOcu4Qyx2) once you're ready to apply the new background. This shows a static (non-moving) version of your source URL or image. You can still interact with your Web Widget prototype like in the first version of the preview. However, this time you can now see how your Web Widget looks like when placed in your website.

{% hint style="info" %}
**Use the static preview to change the colors of your Web Widget!**

You can use the static preview as a "reference" on how your Web Widget looks like in action. Check whether your chosen Options (Text, Color, Image) fit your overall aesthetic and branding.&#x20;

Use this opportunity to make the appropriate changes before you implement this Web Widget in your live website.&#x20;
{% endhint %}


# Channel: Facebook

Set your AI Assistant as a Chatbot of a Facebook Page

<figure><img src="/files/eA1HRjFJL29kEBdc5XuJ" alt="The &#x22;Step 2: Select Channel&#x22; page will have Facebook Messenger highlighted in blue when you click it."><figcaption><p>The "Step 2: Select Channel" page will have Facebook Messenger highlighted in blue when you click it.</p></figcaption></figure>

After ***Select Channel > Facebook Messenger***, you will be taken to ***Configure Facebook Messenger***. This is where you can integrate your AI Chatbot as the dedicated chatbot of your Facebook Page.

{% hint style="info" %}
**SUMMARY**

Creating a Facebook Messenger Chat Flow involves these steps:

1. **Choose Facebook Messenger:** In *Step 2: Select Channel*, choose "Facebook Messenger." This brings you to the *Configure Facebook Messenger* window.
2. **Give your Chat Flow a name and description:** Provide a public name and description for your Chat Flow - these will appear when interacted with as an AI Chatbot in Facebook Messenger.
3. **Connect your Facebook Account:** Click the *Sign in with Facebook* button to log into your Facebook Business Account in a new window.
4. **Choose your Facebook Business Page:** In the same new window, select your Facebook Business Page and accept permissions.
5. **Type your Facebook Page Name:** Back in *Configure Facebook Messenger*, type your Facebook Business Page name as it appears on Facebook.
6. **Wait for Page ID and Page Token to fill:** If you've written the right page name, the Page ID and Page Token will automatically be filled out. &#x20;
   {% endhint %}

{% hint style="danger" %}
**REQUIREMENTS**

Before proceeding with the rest of the Facebook Messenger integration process, make sure you have the following:

* **Facebook Business Page:** You must have a Business Page assigned to your business or brand. This is where users will connect with your company and your agents via your AI Chatbot.
* **Facebook Business Account:** Your Facebook Business Page must be connected to a Facebook Business Account. Make sure it is a **verified** account by following the steps in this [guide from Meta](https://www.facebook.com/business/help/2058515294227817?id=180505742745347).
  {% endhint %}

{% hint style="info" %}
**Works with both Facebook Web and Messenger App**

Since this integration adds an AI Chatbot to your Facebook Page, users can access the new chatbot with the **built-in chat of Facebook Web and the Messenger App.**&#x20;
{% endhint %}

***

## Configure Facebook Messenger

<figure><img src="/files/LjGuSCCcMe7UhHOERzOp" alt="Clicking  &#x22;Facebook Messenger&#x22; in &#x22;Step 2: Select Channel&#x22; and clicking &#x22;Next&#x22; will take users to &#x22;Configure Facebook Messenger.&#x22; You have to fill out the information on this page (Name, Description, Facebook Page Name, Page ID, Page Token) to finish the setup process."><figcaption><p>Clicking  "Facebook Messenger" in "Step 2: Select Channel" and clicking "Next" will take users to "Configure Facebook Messenger." You have to fill out the information on this page (Name, Description, Facebook Page Name, Page ID, Page Token) to finish the setup process.</p></figcaption></figure>

Before you can fully integrate your AI Chatbot with your Facebook Page, you have to fill up the following information in ***Configure Facebook Messenger***:

* **Name:** This is the name of the AI Assistant as it will appear on Facebook.
* **Description:** Give your AI Chatbot a short description.

### Sign in with Facebook

<figure><img src="/files/ik8qDWBfARD6lAJACsfe" alt="After writing the name of your Facebook Messenger Chat Flow under &#x22;Name&#x22; of &#x22;Configure Facebook Messenger,&#x22; click &#x22;Sign in with Facebook&#x22; to be taken to a separate window. You will be instructed to sign in with your Facebook account."><figcaption><p>After writing the name of your Facebook Messenger Chat Flow under "Name" of "Configure Facebook Messenger," click "Sign in with Facebook" to be taken to a separate window. You will be instructed to sign in with your Facebook account.</p></figcaption></figure>

This is the most important step of the integration process. Click ***Sign in with Facebook.***

You will encounter a separate window where you have to log in. Upon logging in, you then have to give Captivate Chat permissions to make modifications to your profile.

### Select the Business Account

<figure><img src="/files/RdsV9O0EwKzztkTQjCok" alt="After logging in to Facebook using the &#x22;Sign in with Facebook&#x22; button of &#x22;Configure Facebook Messenger.&#x22; you will be asked to choose which Facebook Page you want to connect to Captivate Chat."><figcaption><p>After logging in to Facebook using the "Sign in with Facebook" button of "Configure Facebook Messenger." you will be asked to choose which Facebook Page you want to connect to Captivate Chat.</p></figcaption></figure>

Facebook will ask you the following:

* **"What pages do you want to use with Captivate Chat?"**
  * Choose the correct page.&#x20;

You will encounter a drop-down box where you will choose which page you specifically permit us to access. Choose the correct page and tick all the appropriate options.&#x20;

This will allow us to use our backend to automatically integrate your AI Chatbot to your Facebook Page.&#x20;

### Fill up Page ID and Page Token

<figure><img src="/files/PEJ21UqQ13DtM3EwZKPR" alt="After selecting the right Facebook Page in &#x22;Sign in with Facebook,&#x22; the window will close automatically. Write the correct page name in &#x22;Facebook Page Name&#x22; and the &#x22;Page ID&#x22; and &#x22;Page Token&#x22; boxes will automatically be filled out. "><figcaption><p>After selecting the right Facebook Page in "Sign in with Facebook," the window will close automatically and return you to "Configure Facebook Messenger." Write the correct page name in "Facebook Page Name," and the "Page ID" and "Page Token" boxes will automatically be filled out. </p></figcaption></figure>

Back in ***Configure Facebook Messenger**,* fill in the following:

* **Facebook Page Name:** When you start typing your target Facebook Page, it should appear as a drop-down. Select it.
* **Page ID and Page Token:** They should automatically appear after typing your target Facebook Page.

Click ***Next***.

***

## Testing Facebook Configuration

<figure><img src="/files/LSia5BPTktcDI3I5Rl8o" alt="After setting up your Facebook Chat Flow, go to the Facebook Page you just connected to Captivate Chat. Refresh the page and click the &#x22;Message&#x22; button. You should have automated responses as the AI Chatbot had just been deployed there."><figcaption><p>After setting up your Facebook Chat Flow, go to the Facebook Page you just connected to Captivate Chat. </p></figcaption></figure>

You can test your AI Chatbot in these ways:

### Testing via Facebook Page

Go to your Facebook Page.&#x20;

Refresh the window if the tab was open while integrating the AI Chatbot into your Page. Click ![](/files/hzxOiY0MBp3OfeFm2Sk7) at the top of the Page. &#x20;

<figure><img src="/files/pyrPAPG2PNexrQiWgR9R" alt="After clicking the &#x22;Message&#x22; button, you should receive automated responses, as the AI Chatbot has just been deployed there."><figcaption><p>After clicking the "Message" button, you should receive automated responses, as the AI Chatbot has just been deployed there.</p></figcaption></figure>

The AI Chatbot should pop out and present default options. Choose either of these questions.

<figure><img src="/files/EaU6w2faHF3VLHDBCh28" alt="Test your new Facebook Chat Flow by typing a message. The page should automatically respond."><figcaption><p>Test your new Facebook Chat Flow by typing a message. The page should automatically respond.</p></figcaption></figure>

If the integration is successful, your AI Chatbot should respond automatically. After this message, you can start talking to it.

### Testing via Facebook Messenger

Go to your Facebook Messenger app.&#x20;

<figure><img src="/files/8caajsap6ZMdylZCy8lP" alt="In Facebook Messenger, type the name of your Facebook Page."><figcaption><p>In Facebook Messenger, type the name of your Facebook Page.</p></figcaption></figure>

If you want to talk to your AI Chatbot for the first time, look for your Facebook Page via the Messenger search bar.&#x20;

<figure><img src="/files/nUmYoUwCkXISQgIAsdoV" alt="After clicking the name of your Facebook Page, you should see automated responses in your chat. This means your AI Chatbot has been deployed successfully.  " width="188"><figcaption><p>After clicking the name of your Facebook Page, you should see automated responses in your chat. This means your AI Chatbot has been deployed successfully.  </p></figcaption></figure>

When you click your Facebook Page name, your AI Chatbot will reveal a set of default questions. Click any of these questions.

<figure><img src="/files/A7N5Jvi8UyZDCEBbBzlT" alt="Type a question in your conversation with your AI Chatbot in Facebook Messenger. You should receive an automated response." width="188"><figcaption><p>Type a question in your conversation with your AI Chatbot in Facebook Messenger. You should receive an automated response.</p></figcaption></figure>

If the integration is successful, your AI Chatbot should respond automatically. After this message, you can start talking to it.

***

## You're all set!

Doing all the steps above should get your AI Chatbot ready to be used with your Facebook Page.


# Channel: Instagram

Set your AI Assistant as a Chatbot of an Instagram Page

<figure><img src="/files/oO0CBEbw6WWJRxwlfoZf" alt="The &#x22;Step 2: Select Channel&#x22; page will have Instagram highlighted in blue when you click it."><figcaption><p>The "Step 2: Select Channel" page will have Instagram highlighted in blue when you click it.</p></figcaption></figure>

After ***Select Channel > Instagram***, you will be taken to ***Configure Instagram***. This is where you can integrate your AI Chatbot as the assigned bot of your Instagram Page.

{% hint style="info" %}
**SUMMARY**

Creating an Instagram Chat Flow involves these steps:

1. **Choose Instagram:** In *Step 2: Select Channel*, choose "Instagram." This brings you to the *Configure Instagram* window.
2. **Give your Chat Flow a name and description:** Provide a public name and description for your Chat Flow - these will appear when interacted with as an AI Chatbot on Instagram.
3. **Connect your Facebook Account:** Click the *Sign in with Facebook* button to log into your Facebook Business Account in a new window.
4. **Choose your Instagram Professional Account:** In the same new window, select your Instagram Professional Account and accept permissions.
5. **Type your Instagram Page Name:** Back in *Configure Instagram*, type your Instagram username. This is the one you use with the at (@) sign.
6. **Wait for Instagram ID and Page Token to fill:** If you've written the right page name, the Instagram ID and Page Token will automatically be filled out. &#x20;
   {% endhint %}

{% hint style="danger" %}
**REQUIREMENTS**

Before proceeding with the rest of the Instagram integration process, make sure you have the following:

* **Instagram Professional Account:** Your business or brand must have a **Professional Instagram Account**. It cannot be a personal account.&#x20;
* **Facebook Business Account:** Your **Professional Instagram Account** must be connected to a Facebook Business Account. Make sure it is a **verified** account by following the steps in this [guide from Meta](https://www.facebook.com/business/help/2058515294227817?id=180505742745347).
  {% endhint %}

***

## Configure Instagram

<figure><img src="/files/jQgmmkj3BKIhOev97zUd" alt="Clicking  &#x22;Instagram&#x22; in &#x22;Step 2: Select Channel&#x22; and clicking &#x22;Next&#x22; will take users to &#x22;Configure Instagram.&#x22; You have to fill out the information on this page (Name, Description, Instagram Page Name, Instagram ID, Page Token) to finish the setup process."><figcaption><p>Clicking  "Instagram" in "Step 2: Select Channel" and clicking "Next" will take users to "Configure Instagram." You have to fill out the information on this page (Name, Description, Instagram Page Name, Instagram ID, Page Token) to finish the setup process.</p></figcaption></figure>

Before you can fully integrate your AI Chatbot with your Instagram Page, you have to fill in the following information in ***Configure Instagram***:

* **Name:** This is the name of the AI Chatbot as it will appear on Instagram
* **Description:** Give your AI Chatbot a short description.

### Sign in with Facebook

<figure><img src="/files/y78HFkyItSYP3A3O1IFN" alt="After writing the name of your Instagram Chat Flow under &#x22;Name&#x22; of &#x22;Configure Instagram,&#x22; click &#x22;Sign in with Facebook&#x22; to be taken to a separate window. You will be instructed to sign in with your Facebook account."><figcaption><p>After writing the name of your Instagram Chat Flow under "Name" of "Configure Instagram," click "Sign in with Facebook" to be taken to a separate window. You will be instructed to sign in with your Facebook account.</p></figcaption></figure>

This is the most important step of the integration process. Click ***Sign in with Facebook.***

You will encounter a separate window where you have to log in to Facebook. Upon logging in, you must give Captivate Chat permissions to modify your profile.

### Select the Business Account

<figure><img src="/files/z9eC2Ib8wSOm43UCQzlZ" alt=""><figcaption><p>After logging in to Facebook using the "Sign in with Facebook" button of "Configure Instagram." you will be asked to choose which Instagram Professional Account you want to connect to Captivate Chat.</p></figcaption></figure>

Facebook will ask you the following:

* **"What Instagram Professional Accounts do you want to use with Captivate Chat?"**&#x20;
  * Choose the correct Instagram account.
* **"What pages do you want to use with Captivate Chat?"**
  * Choose the correct page.&#x20;

You will encounter a drop-down box where you will choose which **page** you specifically permit us to access. Choose the correct page and tick all the associated boxes.&#x20;

This will allow us to use our backend to automatically integrate your AI Assistant to your Instagram Page.&#x20;

### Fill up Instagram ID and Page Token

<figure><img src="/files/gVQ0PFCU4xjQdVZAuGcO" alt=""><figcaption><p>After selecting the right Instagram Professional Page in "Sign in with Facebook," the window will close automatically and return you to "Configure Instagram." Write the correct page name in "Instagram Page Name," and the "Instagram ID" and "Page Token" boxes will automatically be filled out. </p></figcaption></figure>

Back in ***Configure Instagram**,* fill in the following:

* **Instagram Page Name:** Type the username of your target Instagram account.&#x20;
* **Instagram ID and Page Token:** They should automatically appear after entering your Instagram Page Name.

Click ***Next***.

{% hint style="warning" %}
**Take note of your Instagram username**

When typing the Instagram Page Name, use your **username** - the name you use for tagging (with @). In the case of Captivate Chat, it's *captivatechat*.&#x20;

An easy reference is to check your Instagram Page via a web browser. The name located in the URL is your username. In the case of Captivate Chat, it's: <https://www.instagram.com/captivatechat/>
{% endhint %}

***

### Testing Instagram Configuration

```
image
```

Go to your Instagram Page. If the tab is currently open while integrating the AI Assistant into your Page, refresh the window.

```
image
```

Click ***Message*****.**

```
image
```

Greet the AI Assistant.&#x20;

If the integration is successful, then your Chatbot should be answering with a response.&#x20;

***

## You're all set!

Doing all the steps above should get your Chatbot ready to be used with your Instagram Page.


# Channel: WhatsApp

Set up your AI Assistant as a WhatsApp Chatbot

<figure><img src="/files/nG0zJ16wsv4uEUn5h7kH" alt="After selecting an AI Chatbot in &#x22;Step 1: Select Chatbot,&#x22; choose &#x22;WhatsApp&#x22; in &#x22;Step 2: Select Channel&#x22; in the Chat Flow creation process. The button will be highlighted blue. Click &#x22;Next&#x22; to proceed."><figcaption><p>After selecting an AI Chatbot in "Step 1: Select Chatbot," choose "WhatsApp" in "Step 2: Select Channel" in the Chat Flow creation process. The button will be highlighted blue. Click "Next" to proceed.</p></figcaption></figure>

After ***Select Channel > WhatsApp***, you will be taken to ***Configure WhatsApp***. This is where you can start integrating your AI Assistant into WhatsApp as a Chatbot that people can converse with.&#x20;

{% hint style="info" %}
**SUMMARY**

Connecting your Chat Flow to WhatsApp needs some back and forth between another app called Twilio. Here are the steps:

1. **Set up a Twilio Paid Account:** You need a Twilio Paid Account to assign a phone number to WhatsApp that connects to your Chat Flow.
2. **Create a WhatsApp Sender on Twilio:** On the Twilio dashboard, go to *Messaging > Senders > WhatsApp Senders.* Follow the prompts in the new page to start setting up your WhatsApp Sender.
3. **Fill out basic information on Twilio:** The WhatsApp Sender setup process on Twilio requires you to fill out data. Make sure this is accurate.
4. **Select a phone number on Twilio:** Enter a reserve phone number unconnected to WhatsApp or buy one from Twilio.&#x20;
5. **Connect to WhatsApp:** For your first WhatsApp Sender, you have to put additional information about your business on Twilio and then go to Meta Business Suite to accept the pending Twilio connection request. If you're making your subsequent WhatsApp Senders, use a button on Twilio to sign into Meta and verify your phone number.
6. **Configure the Endpoint:** Go to your recently created WhatsApp Sender on Twilio. Copy the Webhook URL from this guide and paste it onto the Webhook URL text box on the WhatsApp Sender's settings.
7. **Finish the WhatsApp Chat Flow on Captivate Chat:** Copy the Account SID and Authorization Token from your Twilio dashboard and paste it on the necessary fields back in your WhatsApp Chat Flow on Captivate Chat.&#x20;
8. **Test the WhatsApp Chat Flow:** Find your WhatsApp Chat Flow on WhatsApp via the phone number you used on Twilio. It should create automated responses.&#x20;
   {% endhint %}

{% hint style="danger" %}
**REQUIREMENTS**

Before proceeding with the rest of the WhatsApp integration process, make sure you have the following:

* **Twilio Paid Account:** While you can register for a free Twilio account, you need to have a Paid Account to access functionalities needed to integrate WhatsApp into Captivate Chat.&#x20;
* **Phone Number not connected to WhatsApp:** You need to have an extra number not connected to WhatsApp. You can have one prepared or buy one from Twilio. It's important that the number is **not connected to WhatsApp** or the process won't work.&#x20;
* **Facebook Business Account:** Our integration only works if you have a Facebook Business Account. Make sure it is a **verified** account by following the steps in this [guide from Meta](https://www.facebook.com/business/help/2058515294227817?id=180505742745347).
  {% endhint %}

{% hint style="danger" %}
**Get a Twilio Paid Account!**

Crucial steps in this process, such as being able to create a WhatsApp Sender, is only possible with a Twilio Paid Account. After registering for your Twilio Free Account, please upgrade to a Twilio Paid Account.

You cannot use Captivate Chat to integrate your AI Chatbots to WhatsApp without Twilio.
{% endhint %}

{% hint style="warning" %}
**Check for guide updates!**

Unlike other Chat Flows, connecting your AI Chatbot to WhatsApp needs you to use other platforms (Twilio, Meta Business Suite). Make sure to read updated guides and documentation about their processes for more in-depth instructions.&#x20;
{% endhint %}


# Setting up WhatsApp

Set up your AI Assistant as a WhatsApp Chatbot

<figure><img src="/files/I6VHNM6YVqERMH3doA4r" alt=""><figcaption><p>After selecting WhatsApp and clicking "Next" in "Step 2: Select Channel" of the Chat Flow creation process, you will go to the "Configure WhatsApp" page.</p></figcaption></figure>

You will be taken to a ***Configure WhatsApp*** page after selecting WhatsApp in ***Step 2: Select Channel.***&#x20;

This window contains the necessary information that have to be filled out before WhatsApp becomes integrated to your Chat Flow.

## Configure WhatsApp

<figure><img src="/files/4cmJ7k0wkrsee7qFqsgA" alt="Basic information that have to be filled out for a successful WhatsApp integration include the public name of the WhatsApp Chat Flow, a basic description, and a Provider that is set to Twilio by default."><figcaption><p>Basic information that have to be filled out for a successful WhatsApp integration include the public name of the WhatsApp Chat Flow, a basic description, and a Provider that is set to Twilio by default.</p></figcaption></figure>

Before you're able to integrate your AI Chatbot into WhatsApp, you have to fill up a few details:

* **Name:** This will be the assigned name of your AI Chatbot once it appears live on WhatsApp.
* **Description:** This is a short description assigned to your Chatbot.
* **Provider: Twilio** is set as the preset.

***

## Join Twilio

<figure><img src="/files/UNsG2lzZ8iRZuFty517s" alt="The upper right side of the screen of the Twilio homepage has &#x22;Start for Free&#x22; button that leads to the registration process."><figcaption><p>The upper right side of the screen of the Twilio homepage has "Start for Free" button that leads to the registration process.</p></figcaption></figure>

In order to fill up the Account SID and Authentication Token, you have to **sign up for a Twilio** account.

Go to the **Twilio website** at <https://www.twilio.com/>

{% hint style="info" %}
**What is Twilio?**

Twilio is a platform that uses web APIs to perform communication functions, such as text messaging and calls. Captivate Chat will automatically facilitate the connection between Twilio and your AI Chatbot.&#x20;
{% endhint %}

Click ![The upper right side of the screen of the Twilio homepage has "Start for Free" button that leads to the registration process.](/files/77ihD4r5V8IAV4OKvqZ2) and follow the instructions to register a new account. You’ll need to provide your email address and set a password. Afterwards, you have to:

* **Verify your email.** Check your email for a verification link from Twilio and click on it to verify your account.&#x20;
* **Verify your phone number.** Twilio will ask you to **verify your phone number.** Just follow the on-screen instructions. It will involve receiving a validation code.&#x20;
* **Upgrade your account.** Your free trial won't be able to support Twilio to WhatsApp integrations that we need for Captivate Chat. Go to the upper part of your Twilio Console and click ![A new user will have a "Trial" status on the upper part of their Twilio dashboard and an "Upgrade" link beside it. Click the "Upgrade" link and follow its instructions to upgrade a user account.](/files/CGKr8pE7h86HiU1m9dUy), and follow the on-screen instructions to upgrade your account.&#x20;

***

## Creating a WhatsApp Sender

### Go to the Twilio Console (Dashboard)

<figure><img src="/files/GnaoyRinj9gmZGb7T51U" alt="The Twilio dashboard."><figcaption><p>The Twilio dashboard.</p></figcaption></figure>

Log into Twilio. This will bring you to the **Twilio Console**, which serves as your main dashboard.

Alternatively, you can access the Twilio Console via <https://console.twilio.com/>

### WhatsApp Senders

With your Twilio Paid Account, go to your Twilio Console and look for ***WhatsApp Senders***. To do this, you have to:

1. Click ![The Messaging dropdown in the Twilio dashboard appears on the left-hand menu.](/files/czcsw2pBGB3nuPHVkk9S) in the left-hand menu.&#x20;
2. From the drop-down menu, find ![After clicking the Messaging dropdown button, find the Senders drop down button and click it.](/files/maNvtBZ5VHDPBOd1mJyQ) ***>*** ![After going to Messaging > Senders in the Twilio Dashboard, find WhatsApp senders. Click it to open the WhatsApp senders page in Twilio.](/files/thZVn8i7xUiKMzaayjHw)

Depending on what you've already done with Twilio, follow either of these steps:&#x20;

{% content-ref url="/pages/9V0vSylr6LyL9mcl31Iq" %}
[Submit your first WhatsApp Sender](/start-creating/create-a-chat-flow/select-channel/channel-whatsapp/submit-your-first-whatsapp-sender)
{% endcontent-ref %}

{% content-ref url="/pages/HV30wDaOL5mS39RRIv9J" %}
[Setting up more WhatsApp Senders](/start-creating/create-a-chat-flow/select-channel/channel-whatsapp/setting-up-more-whatsapp-senders)
{% endcontent-ref %}


# Submit your first WhatsApp Sender

Set up your AI Assistant as a WhatsApp Chatbot

<figure><img src="/files/PvJIvMrf7WelccUNkBYK" alt="When users create a WhatsApp sender in Twilio for the first time, they will be taken to a Guided Signup window."><figcaption><p>When users create a WhatsApp sender in Twilio for the first time, they will be taken to a Guided Signup window.</p></figcaption></figure>

After creating a Twilio account and going to *Messaging > Senders > WhatsApp Senders* for the first time, you will see a new ***Guided Signup*** window. Click ![The "Create new sender" button in the Messaging > Senders > WhatsApp Senders page of Twilio will take users to the process of creating a WhatsApp Sender.](/files/VMlNhVpNe9CO3icG2w36).&#x20;

{% hint style="warning" %}
**This is the same form when you create new senders**

The process below has the same forms to fill out when creating new senders beyond your first.&#x20;
{% endhint %}

***

## Request WhatsApp Senders

Follow the on-screen instructions on Twilio to apply for WhatsApp access. These steps will mostly involve filling up the required details about your business so you can request access to the WhatsApp API.&#x20;

#### Client Information

<figure><img src="/files/OE9xqEroXvamWomUecye" alt="The first step of creating a first WhatsApp sender in Twilio is to fill up Client Information with the Business&#x27;s Legal Name, its email address, and its Meta Business Manager ID."><figcaption><p>The first step of creating a first WhatsApp sender in Twilio is to fill up Client Information with the Business's Legal Name, its email address, and its Meta Business Manager ID.</p></figcaption></figure>

Fill up your company's information in this Twilio page.&#x20;

* **Client Business's Legal Name**
* **Client Email Address**
* **Client Meta Business Manager ID**

{% hint style="warning" %}
**Find the Meta Business Manager ID in the Meta Business Suite**

You can locate the Meta Business Manager ID via the Meta Business Suite. On the lower-left part of the screen, click ***Settings***. When the new window loads, click the ***Business Portfolio Info*** on the upper part of the screen. Copy the code under ***Business Portfolio ID***.&#x20;
{% endhint %}

## Select a Phone Number

<figure><img src="/files/8L5qljewG7Upe199k49n" alt="The second step of creating a first WhatsApp sender in Twilio is to Select a Phone Number. Users can choose an existing WhatsApp number by following special instructions or buy a new Twilio number."><figcaption><p>The second step of creating a first WhatsApp sender in Twilio is to Select a Phone Number. Users can choose an existing WhatsApp number by following special instructions or buy a new Twilio number.</p></figcaption></figure>

Choose a phone number in this part of the Twilio page. This will be **your company's designated WhatsApp number specifically for talking to your AI Chatbot.**

You have two options in Twilio:

* You can **buy a Twilio phone number**. Access Twilio's list of available numbers via ![The Phone Numbers dropdown is located on the left-hand side of the Twilio screen.](/files/N1L9uS4kuS8uLL7Sh8Jk), then clicking ![The Manage dropdown menu is located under Phone Numbers on the left-hand side of the Twilio dashboard.](/files/1CPOgK3wNSAqDnpygsO8) and selecting ![Buy a Twilio phone number by going to Phone Numbers > Manage in the Twilio dashboard then clicking "Buy a number."](/files/9UYgd24mnFo9rkmElsTZ).
* You can **use your own number**. Twilio calls this process as **BYON (Bring Your Own Number)**. Please follow the instructions in [this Twilio guide](https://help.twilio.com/articles/360052171393-Can-I-register-my-own-phone-number-for-WhatsApp-on-Twilio-?_gl=1*br9h2a*_gcl_au*MTY0OTYxMjg3OC4xNzI0MjQ2Mzc5*_ga*NjAwMDE0NDcuMTcyNDI0NjM3OQ..*_ga_RRP8K4M4F3*MTcyNTM3MzY2MS43LjEuMTcyNTM3Mzg0Ni4wLjAuMA..).

Twilio has its own [Guided Onboarding document](https://www.twilio.com/docs/whatsapp/guided-onboarding) for a more in-depth look on this process, especially for steps outside Captivate Chat.

{% hint style="warning" %}
**Before selecting a number**

Take note of the Twilio warning before proceeding. Twilio has separate instructions if your phone number:

* ...is already connected to the WhatsApp consumer or small business app
* ...is already connected to the WhatsApp Business Platform via a different provider
  {% endhint %}

{% hint style="info" %}
**Buy a Twilio number according to your needs**

If you plan on purchasing a Twilio number, do take note that the service allows you to buy a phone number using different filters. You can choose according to country, capabilities (Voice, SMS, MMS, Fax), and advanced filters such as address requirements.
{% endhint %}

{% hint style="danger" %}
**Get a phone number with SMS enabled**

Since we are going to integrate an AI Chatbot with WhatsApp, prioritize choosing a number with SMS enabled.&#x20;
{% endhint %}

## Fill Out Your Public WhatsApp Sender Profile Information

<figure><img src="/files/OyFNqyt7D6hw8ffUnxB7" alt="The third step of creating a first WhatsApp sender in Twilio is to fill up public WhatsApp Sender profile information with the company&#x27;s display name, address, email, websites, vertical, logo link, and an about statement."><figcaption><p>The third step of creating a first WhatsApp sender in Twilio is to fill up public WhatsApp Sender profile information with the company's display name, address, email, websites, vertical, logo link, and an about statement.</p></figcaption></figure>

Fill up your business information in this part of the Twilio page. This data will be **submitted in order to request for WhatsApp to provide API access**.

* **Business Display Name**
* **Company Address**
* **Company Email**
* **Website**
* **Additional Website**
* **Vertical**
* **Link to Logo**
* **Profile About**

After filling up items in these steps, Twilio will handle the actual setup process with WhatsApp.&#x20;

{% hint style="danger" %}
**WhatsApp API is crucial to the integration**

This step is perhaps **the most important** when it comes to WhatsApp integration. WhatsApp needs to give you access to its API so we can place your AI Chatbot in the system.&#x20;
{% endhint %}

{% hint style="info" %}
**Visible to end users**

Some text boxes you have to fill up are indicated as **visible to end users**. This means the information placed here will be available for end users to see while interacting with your AI Chatbot.&#x20;
{% endhint %}

{% hint style="warning" %}
**Submitting a wrong business display can cause 2-4 week delays**

Before submitting your request, make sure you're submitting the right information about your business. This is especially the case with the **Business Display Name**. Follow [WhatsApp's Display Name Guidelines](https://www.facebook.com/business/help/338047025165344#display-name-guidelines).
{% endhint %}

***

## Accept the Request from Twilio in your Meta Business Suite

<figure><img src="/files/2Fq3OPtiYBFqXObmnktp" alt="After completing the form to create a first WhatsApp sender in Twilio, users should go to their Meta Business Suite and accept the request from Twilio. "><figcaption><p>After completing the form to create a first WhatsApp sender in Twilio, users should go to their Meta Business Suite and accept the request from Twilio. </p></figcaption></figure>

After setting up your **WhatsApp Sender** on Twilio, you will receive a notification in your Meta Business Suite that says Twilio is asking for permissions to send messages on your behalf.&#x20;

To access this, go to your **Meta Business Suite**. From here:

1. Click ![To access requests in the Meta Business Suite, go to the Meta Business Suite and click the Settings button.](/files/1DNnxGcJcG3iCtwEtFju)
2. Go to ![Under the Settings in Meta Business Suite, access pending requests by clicking the Requests button.](/files/7BjEzxMj2BbO7hb6Kv94)
3. Find and **accept** the Twilio request.&#x20;

***

## Find your new WhatsApp Sender

<figure><img src="/files/jIt5ptwPSErWs4H42MLw" alt=""><figcaption><p>After accepting the request from Twilio in Meta Business Suite, users can go back to the Twilio dashboard and go to Messaging > Senders > WhatsApp Senders page. Their first WhatsApp sender should appear. </p></figcaption></figure>

After accepting the Twilio request, you should see your number in the list of WhatsApp Senders on Twilio. Your WhatsApp number is now ready for integration in your Chat Flow.

To create another WhatsApp sender, click ![The "Create new sender" button in the Messaging > Senders > WhatsApp Senders page of Twilio will take users to the process of creating a WhatsApp Sender.](/files/mtKTvJR5VRkzeV9V2VFm) on the upper-right part of the menu.


# Setting up more WhatsApp Senders

<figure><img src="/files/BaebMp2baShhM44umsdw" alt="This time around, a &#x22;Getting started with WhatsApp&#x22; page will appear for all users who want to create WhatsApp senders after their first. The &#x22;Getting started with WhatsApp&#x22; window appears after clicking Messaging > Senders > WhatsApp Senders and clicking the &#x22;Create New Sender&#x22; button. Click &#x22;Get Started&#x22; to begin the process of creating another WhatsApp sender."><figcaption><p>This time around, a "Getting started with WhatsApp" page will appear for all users who want to create WhatsApp senders after their first. The "Getting started with WhatsApp" window appears after clicking Messaging > Senders > WhatsApp Senders and clicking the "Create New Sender" button. Click "Get Started" to begin the process of creating another WhatsApp sender.</p></figcaption></figure>

After going to the *WhatsApp Senders* menu on Twilio, begin the process of creating your WhatsApp Sender. To do this, you have to:&#x20;

1. Click ![The "Get Started" button will appear in the "Get started with WhatsApp" page after if "Click New Sender" in Messaging > Senders > WhatsApp Senders is clicked by a user who already made their first WhatsApp sender.](/files/0cSYjcMYPIDY8wI6V3U6)
2. Acknowledge and accept the Terms & Conditions presented in the new window.

### Select a Phone Number to register

<figure><img src="/files/V8bRtkKE3X6S8JbDEM7W" alt="The first step to create a new WhatsApp Sender for users who already have existing senders is to select a phone number to register. They can use their own number by following special instructions or buy a Twilio phone number."><figcaption><p>The first step to create a new WhatsApp Sender for users who already have existing senders is to select a phone number to register. They can use their own number by following special instructions or buy a Twilio phone number.</p></figcaption></figure>

Choose a phone number in this Twilio page This will be **your company's designated WhatsApp number specifically for talking to your AI Chatbot.**

You have two options:

* You can **buy a Twilio phone number**. Access Twilio's list of available numbers via ![The Phone Numbers dropdown is located on the left-hand side of the Twilio screen.](/files/N1L9uS4kuS8uLL7Sh8Jk), then clicking ![The Manage dropdown menu is located under Phone Numbers on the left-hand side of the Twilio dashboard.](/files/1CPOgK3wNSAqDnpygsO8) and selecting ![Buy a Twilio phone number by going to Phone Numbers > Manage in the Twilio dashboard then clicking "Buy a number."](/files/9UYgd24mnFo9rkmElsTZ).
* You can **use your own number**. Twilio calls this process as **BYON (Bring Your Own Number)**. Please follow the instructions in [this Twilio guide](https://help.twilio.com/articles/360052171393-Can-I-register-my-own-phone-number-for-WhatsApp-on-Twilio-?_gl=1*br9h2a*_gcl_au*MTY0OTYxMjg3OC4xNzI0MjQ2Mzc5*_ga*NjAwMDE0NDcuMTcyNDI0NjM3OQ..*_ga_RRP8K4M4F3*MTcyNTM3MzY2MS43LjEuMTcyNTM3Mzg0Ni4wLjAuMA..).

Twilio has its own [Guided Onboarding document](https://www.twilio.com/docs/whatsapp/guided-onboarding) for a more in-depth look on this process, especially for steps outside Captivate Chat.

{% hint style="warning" %}
**Before selecting a number**

Take note of the Twilio warning before proceeding. Twilio has separate instructions if your phone number:

* ...is already connected to the WhatsApp consumer or small business app
* ...is already connected to the WhatsApp Business Platform via a different provider
  {% endhint %}

{% hint style="info" %}
**Buy a Twilio number according to your needs**

If you plan on purchasing a Twilio number, do take note that the service allows you to buy a phone number using different filters. You can choose according to country, capabilities (Voice, SMS, MMS, Fax), and advanced filters such as address requirements.
{% endhint %}

{% hint style="danger" %}
**Get a phone number with SMS enabled**

Since we are going to integrate an AI Chatbot with WhatsApp, prioritize choosing a number with SMS enabled.&#x20;
{% endhint %}

## Link WhatsApp Business Account with your number

<figure><img src="/files/jFJ0ret3eAaiFGIgwFbD" alt="The second step to create a new WhatsApp Sender for users who already have existing senders is to link their chosen number to a WhatsApp business account."><figcaption><p>The second step to create a new WhatsApp Sender for users who already have existing senders is to link their chosen number to a WhatsApp business account.</p></figcaption></figure>

The next stage in the Twilio process involves **creating or select a pre-made WhatsApp Business Account** and verifying it to be used with Twilio.

### 1. Link your WhatsApp Business Account

<figure><img src="/files/SapfrWldZXMEBP7Gd0U7" alt="In order to link a phone number to a WhatsApp Business Account in Twilio, click &#x22;Continue with Facebook&#x22; button in the &#x22;Create New Sender&#x22; procedure to open Facebook in a new window."><figcaption><p>In order to link a phone number to a WhatsApp Business Account in Twilio, click "Continue with Facebook" button in the "Create New Sender" procedure to open Facebook in a new window.</p></figcaption></figure>

You will be prompted to connect your chosen number to a WhatsApp Business Account. Click ![In order to link a phone number to a WhatsApp Business Account in Twilio, click "Continue with Facebook" button in the "Create New Sender" procedure to open Facebook in a new window.](/files/7mrjGegn4rikq1SCQlW1) to start the setup process. Follow the instructions in the new window.

### 2. Copy the phone number you want to register

<figure><img src="/files/6Vs0muvsMXBwO3W0wlP5" alt="After &#x22;Continue with Facebook&#x22; button opens Facebook in a pop-up window, users can copy their selected phone number into the clipboard by clicking the &#x22;Copy&#x22; button beside it."><figcaption><p>After "Continue with Facebook" button opens Facebook in a pop-up window, users can copy their selected phone number into the clipboard by clicking the "Copy" button beside it.</p></figcaption></figure>

Part of the verification process in this Twilio page will involve copying your designated phone number over to the Facebook pop-up window. Click ![After "Continue with Facebook" button opens Facebook in a pop-up window, users can copy their selected phone number into the clipboard by clicking the "Copy" button beside it.](/files/KdmxU6CRk6zqexXbz1SA) to place your chosen number in the clipboard.

### 3. Verify the selected number with WhatsApp

<figure><img src="/files/U7qaiLFSRUJKvJnl7Icb" alt="Users should press the &#x22;Send Code&#x22; in the Facebook pop-up window to send a verification code to the selected phone number. The code automatically appears in the blank spaces in the Twilio page of the WhatsApp Sender creation process."><figcaption><p>Users should press the "Send Code" in the Facebook pop-up window to send a verification code to the selected phone number. The code automatically appears in the blank spaces in the Twilio page of the WhatsApp Sender creation process.</p></figcaption></figure>

Press the **Send Code** over in the Facebook pop-up window that appeared. A verification code should automatically appear on the blank spaces in this part of the Twilio page.&#x20;

Twilio should be attempting to register the phone number to WhatsApp. The process generally takes a few moments. The upper-right of the screen will provide these status messages:

<figure><img src="/files/2AR6TGgddZ3gwDAbivb4" alt="Status updates will appear on the upper-right side of the Twilio dashboard during the WhatsApp number registration process. The first status will be an attempt to register the WhatsApp sender, and another is the confirmation of a successful registration."><figcaption><p>Status updates will appear on the upper-right side of the Twilio dashboard during the WhatsApp number registration process. The first status will be an attempt to register the WhatsApp sender, and another is the confirmation of a successful registration.</p></figcaption></figure>

***

## Find your new WhatsApp Sender

<figure><img src="/files/jlZCl5S5yVBIFEArINdx" alt="After verifying the new WhatsApp number in the separate window, users will be redirected to the WhatsApp Senders page. Their new WhatsApp sender should appear. "><figcaption><p>After verifying the new WhatsApp number in the separate window, users will be redirected to the WhatsApp Senders page. Their new WhatsApp sender should appear. </p></figcaption></figure>

After verifying your new WhatsApp number on Twilio, you will be redirected to your list of WhatsApp Senders. Your new WhatsApp sender should be in this list and ready to be integrated in a Captivate Chat Flow.

To create another WhatsApp sender, click ![The "Create new sender" button in the Messaging > Senders > WhatsApp Senders page of Twilio will take users to the process of creating a WhatsApp Sender.](/files/mtKTvJR5VRkzeV9V2VFm) on the upper-right part of the Twilio menu.


# Configure the Endpoint for Integration

Finish setting up your WhatsApp Chat Flow

<figure><img src="/files/KF0PX6TpvyQvEmW24Wqy" alt="Clicking a specific WhatsApp Sender in the Messaging > Senders > WhatsApp Senders list in Twilio will reveal various technical information about this WhatsApp Sender."><figcaption><p>Clicking a specific WhatsApp Sender in the Messaging > Senders > WhatsApp Senders list in Twilio will reveal various technical information about this WhatsApp Sender.</p></figcaption></figure>

Once you have your WhatsApp Sender approved, they should appear in the *WhatsApp Senders* list on Twilio. Access this again by going to your Twilio Console and:

1. Click ![The Messaging dropdown in the Twilio dashboard appears on the left-hand menu.](/files/czcsw2pBGB3nuPHVkk9S) in the left-hand menu.&#x20;
2. From the drop-down menu, find ![After clicking the Messaging dropdown button, find the Senders drop down button and click it.](/files/maNvtBZ5VHDPBOd1mJyQ) ***>*** ![After going to Messaging > Senders in the Twilio Dashboard, find WhatsApp senders. Click it to open the WhatsApp senders page in Twilio.](/files/thZVn8i7xUiKMzaayjHw)

From this list on Twilio, click the WhatsApp number you dedicated to your AI Chatbot.

<figure><img src="/files/Nr0c49BhnK83HGYPq60Y" alt="In the WhatsApp Sender&#x27;s profile page in Messaging > Senders > WhatsApp Senders, go to &#x22;Endpoint Configuration&#x22; section and paste a specific Webhook URL from the Captivate Chat guide in the &#x22;Webhook URL for Incoming Messages.&#x22;"><figcaption><p>In the WhatsApp Sender's profile page in Messaging > Senders > WhatsApp Senders, go to "Endpoint Configuration" section and paste a specific Webhook URL from the Captivate Chat guide in the "Webhook URL for Incoming Messages."</p></figcaption></figure>

Find the section called **Endpoint Configuration** in the WhatsApp Sender's settings. Under the **Webhook URL for Incoming Messages**, paste the following:

```
https://channel.prod.captivat.io/api/whatsapp/twilio/integration 
```

After entering the URL, click ***Save*** or ***Update*** to apply the changes.&#x20;

***

## Copy the Account SID and Authentication Token

<figure><img src="/files/dxzbcyzR6gZXWOuzDZIa" alt="Go to your Twilio dashboard. On the bottom side of the Twilio dashboard is an Account SID and Auth Token. Copy both these values and paste them in your WhatsApp Chat Flow in Captivate Chat."><figcaption><p>Go to your Twilio dashboard. On the bottom side of the Twilio dashboard is an Account SID and Auth Token. Copy both these values and paste them in your WhatsApp Chat Flow in Captivate Chat.</p></figcaption></figure>

Back on the Twilio Console, locate your **Account SID** and **Auth Token.**

They should be located on the ![The "Account Dashboard" button in Twilio takes users to the main Twilio dashboard.](/files/MdjRsuz4biqiBvgVB510).

***

## Paste the Account SID and Authentication Token in Captivate Chat

<figure><img src="/files/l0Ikee6IC5n0beAIcqHV" alt="In the WhatsApp Chat Flow in Captivate Chat, go to the &#x22;Configure WhatsApp&#x22; page as found in &#x22;Step 2: Channel&#x22; and paste the other information in the Account SID and Authentication Token from Twilio."><figcaption><p>In the WhatsApp Chat Flow in Captivate Chat, go to the "Configure WhatsApp" page as found in "Step 2: Channel" and paste the other information in the Account SID and Authentication Token from Twilio.</p></figcaption></figure>

Go back to Captivate Chat.&#x20;

1. Paste the copied Account SID and Authentication Token into the respective fields.
2. Click ***Next***.

***

## Testing WhatsApp Configuration

<figure><img src="/files/MP3BNSuiGDYhRIXnaGap" alt=""><figcaption><p>After the WhatsApp Chat Flow has been finished, users can test the configuration by inputting their Twilio WhatsApp Sender's phone number in WhatsApp. The integration is working if the AI Chatbot is responding automatically.</p></figcaption></figure>

You should be ready to use WhatsApp on Twilio, thanks to Captivate Chat integration!

Locate your AI Chatbot by inputting the assigned WhatsApp number in your WhatsApp program.

Type a message and wait for your AI Chatbot to respond.&#x20;

***

## You're all set!

Doing all the steps above should get your Chatbot ready to be used with WhatsApp.


# Channel: Full Chat

Integrate your AI Chatbot into a full browser page.

<figure><img src="/files/WDckLEej5MXaVpI6BqMX" alt="The &#x22;Step 2: Select Channel&#x22; page will have Full Chat highlighted in blue when you click it."><figcaption><p>The "Step 2: Select Channel" page will have Full Chat highlighted in blue when you click it.</p></figcaption></figure>

After ***Select Channel > Full Chat***, you will be taken to ***Configure Full Chat Channel***. This is where you can integrate your AI Chatbot as the dedicated chatbot of your Facebook Page.

{% hint style="info" %}
**SUMMARY**

Creating a Full Chat Channel involves these steps:

1. **Choose Full Chat:** In *Step 2: Select Channel*, choose "Full Chat." This brings you to the *Configure Full Chat Channel* window.
2. **Give your Chat Flow a name** Provide an internal name for your Chat Flow - these will appear when interacted with as an AI Chatbot in the Full Chat.&#x20;
3. **Provide Client Name, Client Logo and Description:** Under General Settings, provide the Client Name to be used in the URL and their logo, as well as a Description of the Full Chat Channel.&#x20;
4. **Choose your theme colors:** Under Theme Configuration, select colors for Light Theme and Dark Theme of your Full Chat Channel.
5. **Provide Avatar Name, Background Image, Introduction Message, and Chat Header Message:** Under Avatar Configuration, Provide a Background Image for your Full Chat Channel as well as the public name of your AI Chatbot (Avatar Name), the Full Chat's introductory message, and a message to users on top of the Full Chat Channel.&#x20;
   {% endhint %}

***

## Configure Full Chat Channel

<figure><img src="/files/mWg3tcZr0pYbfYe92xtR" alt="Clicking  &#x22;Full Chat&#x22; in &#x22;Step 2: Select Channel&#x22; and clicking &#x22;Next&#x22; will take users to &#x22;Configure Full Chat Channel.&#x22; You have to fill out three tabs (General, Theme, and Avatar) to finish the process."><figcaption><p>Clicking "Full Chat" in "Step 2: Select Channel" and clicking "Next" will take users to "Configure Full Chat Channel." You have to fill out three tabs (General, Theme, and Avatar) to finish the process.</p></figcaption></figure>

Customizing your Full Chat Channel in order to become fully deployable is done through three (3) major steps:

* **General:** This is where you'll fill up basic information about your Full Chat Channel.
* **Theme:** These are simple customization options for your Full Chat Channel's browser appearance. Don't worry, we have a preset option that looks nice!
* **Avatar:** These are options to customize your AI Chatbot Avatar's basic descriptions.

***

## General Settings

<figure><img src="/files/n5SDRJSiFscBJq3nAmCT" alt="The &#x22;General&#x22; tab is the first tab under &#x22;Configure Full Chat Channel&#x22; and will ask users to fill in basic details about the Full Chat, including the internal Channel Name, the subdomain name for previewing, the Client Logo used, and a general Description."><figcaption><p>The "General" tab is the first tab under "Configure Full Chat Channel" and will lead users to General Settings. This will ask users to fill in basic details about the Full Chat, including the internal Channel Name, the subdomain name for previewing, the Client Logo used, and a general Description.</p></figcaption></figure>

When you start creating your Full Chat Channel, you will be led to the **General Settings.** This is where you'll be providing the basic information of your Full Chat Channel, such as:

* **Channel Name:** The internal name of your Full Chat Channel.
* **Client Name:** This is the name you will be using in the URL when previewing the Full Chat Channel.
* **Client Logo**
  * **Client Logo URL:** This will auto-fill after you upload a Client Logo.
* **Description:** Describe your Full Chat Channel.

Click ***Next*** to proceed to the next tab.

***

## Theme Configuration

<figure><img src="/files/IXfNyCzeprV3WIa7io2E" alt="The &#x22;Theme&#x22; tab is the second tab under &#x22;Configure Full Chat Channel&#x22; and will lead users to Theme Configuration. This will ask users for basic color selection that will determine the color palette to be used for the light mode and dark mode of the Full Chat Channel."><figcaption><p>The "Theme" tab is the second tab under "Configure Full Chat Channel" and will lead users to Theme Configuration. This will ask users for basic color selection that will determine the color palette to be used for the light mode and dark mode of the Full Chat Channel.</p></figcaption></figure>

The second tab of the "Configure Full Chat Channel" page is **Theme Configuration**. This will let you set up the color palettes of both the **Light Theme** and **Dark Theme** of your Full Chat Channel.

<figure><img src="/files/PIh2IwmKMUCMm0ooXyoY" alt="This is the view of the Dark sub-tab under &#x22;Theme&#x22; tab (Theme Configuration) of the &#x22;Configure Full Chat Channel.&#x22; The layout of the Dark sub-tab is the same as the Light sub-tab, and changing any of the colors will reflect on the &#x22;Theme Preview&#x22; below."><figcaption><p>This is the view of the Dark sub-tab under "Theme" tab (Theme Configuration) of the "Configure Full Chat Channel." The layout of the Dark sub-tab is the same as the Light sub-tab, and changing any of the colors will reflect on the "Theme Preview" below.</p></figcaption></figure>

Changing any of the colors via the color picker will update a **Theme Preview** below them.

Click ***Next*** to proceed to the next tab.

***

## Avatar Configuration

<figure><img src="/files/WfpNbRaA788HmRDuoURd" alt="The &#x22;Avatar&#x22; tab is the third tab under &#x22;Configure Full Chat Channel&#x22; and will lead users to Avatar Configuration. This will ask users for basic details about their Avatar, the Background Image of their Full Chat Channel, an Introduction Message, and a Chat Header Message."><figcaption><p>The "Avatar" tab is the third tab under "Configure Full Chat Channel" and will lead users to Avatar Configuration. This will ask users for basic details about their Avatar, the Background Image of their Full Chat Channel, an Introduction Message, and a Chat Header Message.</p></figcaption></figure>

The third and last tab of the "Configure Full Chat Channel" window is **Avatar Configuration**, where we can further customize the AI Chatbot's appearance in the Full Chat Channel. Options are:

* **Avatar Name:** The name of the AI Chatbot that will be revealed in the Full Chat Channel.
* **Background Image**
  * **Background Image URL:** This will auto-populate after you upload a Background Image.
* **Introduction Message:** Welcome your users with this message.
* **Chat Header Message:** The message that appears at the top of the Full Chat Channel.

Click ***Next*** or !["Create Channel" under "Configure Full Chat Channel" will create the Full Chat Channel. ](/files/8gfdVRoQn11pQ6ocs9lW) to finish creating your Channel.&#x20;

***

## Chat Channel Created Successfully

<figure><img src="/files/OpNcy93JW43CccjcC9hE" alt="The &#x22;Chat Channel Created Successfully&#x22; will appear after you complete the three tabs of the &#x22;Configure Full Chat Channel&#x22; page. The &#x22;Chat Channel Created Successfully&#x22; has three tabs summarizing the General, Theme, and Avatar tabs. You can click &#x22;Visit Chat&#x22; to see the Full Chat Channel in action."><figcaption><p>The "Chat Channel Created Successfully" will appear after you complete the three tabs of the "Configure Full Chat Channel" page. The "Chat Channel Created Successfully" has three tabs summarizing the General, Theme, and Avatar tabs. You can click "Visit Chat" to see the Full Chat Channel in action.</p></figcaption></figure>

After you finish the three tabs of the "Configure Full Chat Channel" page, you will see the **Chat Channel Created Successfully** window. This summarizes all the choices you've made so far, as well as a link you can copy to preview the Full Chat Channel.

Click  ![You can click "Visit Chat" in the "Chat Channel Created Successfully" page to see the Full Chat Channel in action.](/files/Gc8CwTa6sxe3XD0RcvPy) to preview your Full Chat Channel. This closes the "Chat Channel Created Successfully" window.&#x20;


# Preview Full Chat Channel

Preview your Full Chat Channel via the "Visit Site" at the last stage of the Configure Full Chat Channel page.

<figure><img src="/files/AbFwUnMRjezuNedHvACv" alt="Clicking &#x22;Visit Site&#x22; in &#x22;Chat Channel Created Successfully&#x22; will reveal a full browser page dedicated to the Full Chat Channel. This version samples Athena, a prototype for Adobe. "><figcaption><p>Clicking "Visit Site" in "Chat Channel Created Successfully" will reveal a full browser page dedicated to the Full Chat Channel. This version samples Athena, a prototype for Adobe. </p></figcaption></figure>

***

## Login To Your Account

Before you can access the Full Chat Channel, you have to login with a valid account. To do this:

1. Select your desired language.
2. Click "Login to your account."
3. Type your credentials and click "Login to your account."

<figure><img src="/files/UZqRRoQgfCNr0AsMDvx1" alt=""><figcaption><p>The preview of the Full Chat Channel will ask you to select a language before you can access the full channel. After selecting your desired language, click "Login to your account."</p></figcaption></figure>

<figure><img src="/files/sZDoRNZ75ZY2ouctdo2S" alt=""><figcaption><p>Enter your credentials in this login screen, then click "Login to your account."</p></figcaption></figure>

***


# Channel: Custom Channel

Set your AI Assistant as a Chatbot of a Custom Channel, whether a unique app, social media platform, website, or other means.

<figure><img src="/files/aOo732zdjPVBOq7CT5iM" alt=""><figcaption><p>The "Step 2: Select Channel" page will have Custom Channel highlighted in blue when you click it.</p></figcaption></figure>

After ***Select Channel > Custom Channel***, you will be taken to ***Configure Custom Channel***. This is where you can integrate your AI Chatbot as the assigned bot of your Custom Channel.

* If you are using **JavaScript** in your application, you can use our Chat Library for rapid deployment: [JavaScript Socket API](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel/javascript-socket-api)
* If you are **not using JavaScript,** we advise you read through our full socket documentation [here.](https://www.npmjs.com/package/captivate-chat-api)&#x20;

{% hint style="info" %}
**SUMMARY**

Creating a Custom Channel Chat Flow involves these steps:

1. **Choose Custom Channel** In *Step 2: Select Channel*, choose "Custom Channel." This brings you to the *Configure Custom Channel* window.
2. **Give your Chat Flow a name and description:** Provide a Name and Description for your Custom Channel. This will its description within Captivate Chat.
3. **Get API Key:** Click *Create Channel* after putting a Name and a Description. This creates the Custom Channel and gives you a unique API Key.
4. **Plug in the API Key into your developer environment:** Use the API Key in your developer environment alongside our Captivate Chat WebSocket tools.
   {% endhint %}

{% hint style="danger" %}
**REQUIREMENTS**

Before proceeding with the rest of the Custom Channel integration process, make sure you have the following:

* **Access to our WebSocket tools:** Get our WebSocket package in [this link](https://www.npmjs.com/package/captivate-chat-api).
* **An active developer environment:** Our Custom Channel is not an independent tool. Rather, it has to be plugged into an existing developer environment.
  {% endhint %}

{% hint style="warning" %}
**REMINDER**

The Custom Channel is a **development-heavy tool**. It needs more active testing compared to our other Channel types.&#x20;

It is advisable that you assign a developer to create a Custom Channel with Captivate Chat using this process.

Please contact our Support Team if you need assistance in implementing a Custom Channel in your producs and services.
{% endhint %}

***

## Configure Custom Channel

<figure><img src="/files/4oKs7Db6eabi42ciN4PJ" alt=""><figcaption><p>Clicking  "Custom Channel" in "Step 2: Select Channel" and clicking "Next" will take users to "Configure Custom Channel." You have to fill out the information on this page (Next, Description) to finish the setup process.</p></figcaption></figure>

Before you can fully integrate your AI Chatbot with your Custom Channel, you have to fill in the following information in ***Configure Custom Channel***:

* **Name:** This is the name of the AI Chatbot as it will appear on your Custom Channel
* **Description:** Give your AI Chatbot a short description.

After you give your Custom Channel a name and a description, click *Create Channel.*

### API Key

<figure><img src="/files/9lIY3sdmrBDevXQXI8Kj" alt="You will get an API Key after clicking &#x22;Create Channel&#x22; in the &#x22;Configure Custom Channel.&#x22; "><figcaption><p>You will get an API Key after clicking "Create Channel" in the "Configure Custom Channel." </p></figcaption></figure>

<figure><img src="/files/qXh8Rd44rNCWo5lW5HFv" alt="After clicking &#x22;Create Channel&#x22; under &#x22;Configure Custom Channel,&#x22; you can now view your API Key once more with the &#x22;Show API key&#x22; button. However, when you make changes to your Custom Channel&#x27;s Name and/or Description, you have to click &#x22;Create Channel&#x22; again to save those changes, which then generates a new API Key."><figcaption><p>After clicking "Create Channel" under "Configure Custom Channel," you can now view your API Key once more with the "Show API key" button. However, when you make changes to your Custom Channel's Name and/or Description, you have to click "Create Channel" again to save those changes, which then generates a new API Key.</p></figcaption></figure>

When you make your Custom Channel, you will now get a special API Key. You can view it whenever you want via the new ***Show API Key*** button that appears on the page.

However, when you edit your Custom Channels' Name and/or Description, you have to click ***Create Channel*** again to save your changes, which then generates a new API Key you have to plug in to your website or app.

***

## Test your Custom Channel!

Doing all the steps above should get your Chatbot ready to be used with your Custom Channel. However, it might still need some testing.&#x20;

You may proceed with the following:

{% content-ref url="/pages/OPO8FRjXxKQpqpTyO158" %}
[JavaScript Socket API](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel/javascript-socket-api)
{% endcontent-ref %}

{% content-ref url="/pages/Y6tw6BALlS1m11l4lQFP" %}
[Socket API](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel/socket-api)
{% endcontent-ref %}

{% content-ref url="/pages/bNiLoDrwqecfza2n8Gvh" %}
[Socket Conversation Testing](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel/socket-conversation-testing)
{% endcontent-ref %}


# JavaScript Socket API

JavaScript Socket API Chat Library that correspond to processes that transform your Custom Channel into a fully functional AI Chatbot.

This is the Chat Library of the **JavaScript Socket API** that is currently available and compatible with the Captivate Chat platform. These are all intended to create processes that will transform your Custom Channel into a full-blown AI Chatbot.

They are also available [here](https://www.npmjs.com/package/captivate-chat-api).

{% hint style="warning" %}
**REMINDER**

This JavaScript Socket API is advisable to be used by developers familiar with the product or service you want to transform into a Custom Channel.&#x20;

Please provide this page to them so they can conduct proper testing with the Custom Channel you want to create.
{% endhint %}

***

### Basic Setup

Import and initialize the API client:

```
import { CaptivateChatAPI } from 'captivate-chat-api';

const api = new CaptivateChatAPI('YOUR_API_KEY');

// Connect to the WebSocket server
await api.connect();
```

### Create a Conversation

Create a new conversation with the following options:

1. Basic setup with just a user ID:

   ```
   const conversation = await api.createConversation('user123');
   ```
2. Include user information and custom data:

   ```
   const conversation = await api.createConversation(
     'user123',
     {
       name: 'John Doe',
       email: 'john@example.com'
     },
     {
       customField: 'value'
     },
     'user-first' // Start the conversation with user-first or bot-first mode
   );
   ```

### Send and Receive Messages

1. Send a message to the conversation:

   ```
   await conversation.sendMessage('Hello!');
   ```
2. Listen for responses:

   ```
   conversation.onMessage((message, type) => {
     console.log(`${type}: ${message}`);
   });
   ```

### Handle Events

Use event listeners to handle various updates, errors, or custom actions:

1. Error handling:

   ```
   conversation.onError((error) => {
     console.error('Error:', error);
   });
   ```
2. Updates on conversation status:

   ```
   conversation.onConversationUpdate((update) => {
     console.log('Conversation Update:', update);
   });
   ```
3. Handling custom actions:

   ```
   conversation.onActionReceived((actions) => {
     console.log(`Actions:`, actions);
   });
   ```

### Get Conversation History

Retrieve the transcript of a conversation:

```
const transcript = await conversation.getTranscript();
console.log('Transcript:', transcript);
```

### Delete Conversation

Delete the current conversation

```
const transcript = await conversation.delete();
console.log('Deleted conversation');
```

### Retrieve User Conversations

Fetch a list of conversations associated with a specific user ID:

```
const conversations = await api.getUserConversations('user123');
console.log('User Conversations:', conversations);
/*
 Returns Conversation Object
 */
```

### Delete User Conversations

Delete list of conversations associated with a specific user ID:

```
const conversations = await api.deleteUserConversations('user123');
console.log('Conversations Deleted successfully');
/*
 Throws error if failed
 */
```


# Socket API

Socket API Chat Library that correspond to processes that transform your Custom Channel into a fully functional AI Chatbot.

This is the Chat Library of the **Socket API** that is currently available and compatible with the Captivate Chat platform. These are all intended to create processes that will transform your Custom Channel into a full-blown AI Chatbot.

The full documentation is available [here](https://www.npmjs.com/package/captivate-chat-api).

{% hint style="warning" %}
**REMINDER**

This Socket API is advisable to be used by developers familiar with the product or service you want to transform into a Custom Channel.&#x20;

Please provide this page to them so they can conduct proper testing with the Custom Channel you want to create.
{% endhint %}

***

### socket\_connected

Successful creation of a Channel session.

**Emit :** No\
**Receive :** Yes\
**Payload**

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "socket_connected",
        "event_id": "Vp6roFYZLPEFfcg=",
        "event_payload": {
            "socket_id": "Vp6roemHLPECFOQ="
        },
        "accepts_response_payload": false
    }
}
```

***

### conversation\_start

Send this event to start a new conversation in Captivate Chat. On successful creation, expect to `receive bot_messages` and be able to send user\_messages.&#x20;

**Emit** : Yes\
**Receive** : No\
**Payload** :

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "conversation_start",
        "event_payload": {
            // userId - optional. if not provided, CH will assign "anon" as the userId.
            "userId": "super-unique-user-id",
            // userBasicInfo - optional. if provided, basic info is sent in livechat and chatbot
            "userBasicInfo": { //optional
                "firstName": "John",
                "lastName": "Doe",
                "email": "john@sample.io"
            //DEV NOTE: Add phone number nalang here   
            },
            // userData - optional. if provided, basic info is sent in livechat and chatbot
            "userMetadata": {
            
            }
            //DEV NOTE: CHANGE TO userMetadata, metadata updates will be pushed here too.
        }
    }
}
```

***

### conversation\_start (with metadata)

This action initiates a new conversation for a specific user and allows you to attach metadata, such as user details.

**Emit: Yes**\
**Receive: No**\
**Payload:**

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "conversation_start",
        "event_payload": {
            "userId": "super-unique-user-id",
            "userBasicInfo": {
                "firstName": "John",
                "lastName": "Doe",
                "email": "john@sample.io"
            },
            "userData": {}, 
            "metadata": {
                "sample": "sample"
            }
        }
    }
}
```

***

### conversation\_start\_success

This event is received event to start a new conversation in a Captivate Flow.&#x20;

On successful creation, expect to receive `bot_messages` immediately with the same `conversation_id` received here. Consider this as a confirmation that conversation start request has been successful.

**Emit** : No\
**Receive** : Yes\
**Payload** :

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "conversation_start_success",
        "event_payload": {
            "conversation_id": "super-unique-user-id-d1816568-2b18-4e8b-a09e-ec6f86eeccfd"
        },
        "event_id": "Vp6xHFY9LPEFYXw=",
        "accepts_response_payload": false
    }
}
```

***

### user\_message

User messages sent from the client application.

**Emit :** Yes\
**Receive :** No\
**Payload**

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "user_message",
        "event_payload": {
            "type": "message_create",
            "client_msg_id": "unique-message-id", // Unique message ID to be set by client, UUID type format is preferable.
            "conversation_id": "temp123-aaaaa-aaaa", //Unique conversation session ID from Captivate Hub
            "content": {
                "type" : "text", // current supported type
                "text": "hello"
            }
        }
    }
}
```

***

### bot\_message

Bot messages sent from the Chat Flow.\
**Emit** : No\
**Receive** : Yes\
\
**Payload showing the model of the bot\_message content**

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "bot_message",
        "event_payload": {
            "type": "message_create",
            "ch_msg_id": "f14efe6e-773a-4a52-85f5-90b6d801f2d1",
            "bot": {},
            "content": [{
                // current supported types
                "type" : "text || buttons || cards",
                // sent only when type is "text"
                "text" : "bot text message",
                // sent only when type is "buttons"
                "buttons" : {},
                // sent only when type is "cards"
                "cards" : {}
            }]
        },
        "event_id": "Vp6x7GxOLPEFb7A=",
        "accepts_response_payload": false
    }
}

```

**Payload example**

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "bot_message",
        "event_payload": {
            "type": "message_create",
            "ch_msg_id": "f14efe6e-773a-4a52-85f5-90b6d801f2d1",
            "bot": {},
            "content": [
                {
                    "text": "Hi. I'm the Captivate Bot.",
                    "type": "text"
                },
                {
                    "text": "You can leave us your contact details or you can chat to us directly now!",
                    "type": "text"
                },
                {
                    "type": "button",
                    "buttons": {
                        "title": "Please choose from one of the following:",
                        "options": [
                            {
                                "label": "Leave Contact Details",
                                "value": "Leave Contact Details"
                            },
                            {
                                "label": "Chat to Agent",
                                "value": "Chat to Agent"
                            }
                        ]
                    }
                }
            ]
        },
        "event_id": "Vp6x7GxOLPEFb7A=",
        "accepts_response_payload": false
    }
}
```

***

### sendMessage (with files)

This action sends a message from a user and includes file attachments.

**Emit: Yes**\
**Receive: No**\
**Payload:**

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "user_message",
        "event_payload": {
            "type": "message_create",
            "client_msg_id": "unique-message-id",
            "conversation_id": "6f61b997-6e2c-471e-8481-27a584c5dcdc",
            "content": {
                "files": [
                    {
                        "url": "https://sample.pdf",
                        "type": "application/pdf",
                        "filename": "sample.pdf"
                    }
                ]
            }
        }
    }
}
```

***

### livechat\_message

Live Chat messages sent from the connected live chat application (Slack, MS Teams, Freshdesk, etc.).

**Emit :** No\
**Receive :** Yes\
**Payload**

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "livechat_message",
        "event_payload": {
            "type": "message_create",
            "conversation_id": "",
            "content": [ // array of agent messages
                {
                    "text": "hello",
                    "type": "text"
                },
                {
                    "files": [
                        {
                            "type": "image",
                            "url": "https://fc-euc1-00-pics-bkt-00.s3.eu-central-1.amazonaws.com/9ca67af811a929e146797ca9a098a7baa924f5f3f97462ea995a15f3f6ef6b39/f_marketingpicFull/u_c3f0d156af45b476c0be56a8d22f56bc4df846910c1b1a5b6ff1d8f4577b4d9d/img_37o2ah9f8j_309cbb43ff98c47af2ee993cb95fe23f9349f6e2386d9d188cf23b0fe8c336ec.jpeg",
                            "mimetype": "image",
                            "filename": null
                        }
                    ],
                    "type": "files"
                }
            ]
        },
        "event_id": "103fb31a-a70c-4b16-977c-917956ff12ae",
        "accepts_response_payload": false
    }
}
```

***

### metadata

Metadata that can be set from the client application. This [Captivate Chat document](https://manual.captivat.io/install/chatbot/watson-assistant/the-captivate-hub-integration/metadata) details how and why metadata is used in Captivate Chat. Examples of metadata that can be set are channel user data and sending preconfigured data depending on where the user is on the website. This metadata will be saved in Captivate Chat sessions and can be retrieved if required.

**Emit :** Yes\
**Receive :** No\
**Payload**

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "metadata",
        "event_payload": {
            "metadata": { //Object to contain any custom metadata
                "sample_metadata": "Sample metadata"
            },
            "target" : "default || bot || live || bot_live",
            "client_msg_id": "unique-message-id",Javasc
            "conversation_id": "temp123-aaaaa-aaaa"
        }
    }
}
```

***

### action

Aside from messages, `actions` can also be exchanged by the client application and Captivate Chat. Actions can be used for triggering events on both sides.

For example, a reserved CH action `“escalateToHuman”` can be emitted from the client application for this example scenario:

> There is button in the Web Widget that the user can click to ask for a Live Chat agent for assistance. Client application should then emit an action to Captivate Chat, and the Chat Flow will handle the action accordingly.

It is also possible to receive an action from Captivate Chat for an example scenario:

> A user asks the chatbot “How do I reach you”, the chatbot then recognizes this and sends an [outgoing action](https://manual.captivat.io/install/chatbot/watson-assistant/the-captivate-hub-integration/outgoing-action)  back to the channel with a title “redirectToContactUs”. It is up to the client application developer then to utilize the action received.

**Emit** : Yes\
**Receive** : Yes\
**Payload**

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "action",
        "event_payload": {
            "type": "normal", // type can be utilized by developers, but by default this is set to "normal"
            "id": "escalateToHuman", // Action ID Java
            "data": {}, //Object to contain any custom supporting data for the action
            "conversation_id": "temp123-aaaaa-aaaa"
        }
    }
}
```

***

### conversation\_transcript\_request

Send this event to request for the conversation transcripts associated with a socket connection. Expect to receive a `conversation_transcript` event as a response.

**Emit** : Yes\
**Receive** : No\
**Payload** :

<pre class="language-javascript"><code class="lang-javascript">{
    "action": "sendMessage",
    "event": {
        "event_type": "conversation_transcript_request",
        "event_payload": {
<strong>            "conversation_id": "assigned conversation id"
</strong>        }Javasc
    }
}
</code></pre>

***

### get\_conversations

Request the list of Conversation IDs for a specific user by providing their `userId`

**Emit:** Yes\
**Receive:** Yes\
**Payload:**&#x20;

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "get_conversations",
        "event_payload": {
            "userId": "aidan"
        }
    }
}
```

**Sample Response:**

<figure><img src="/files/j5S58U8GrgbDn2PQYob5" alt=""><figcaption></figcaption></figure>

***

***

### delete\_conversation

This action removes an existing conversation using `conversation_id.`

**Emit:** Yes\
**Receive: No**\
**Payload:**&#x20;

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "delete_conversation",
        "event_payload": {
            "conversation_id": "hart_0bf45c1c-dbf7-4ece-ac17-abb2a41e160b"
        }
    }
}
```

***

***

### delete\_conversation (all conversations)

This action removes all existing conversation using `userId`

**Emit:** Yes\
**Receive:** No\
**Payload:**&#x20;

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "delete_conversation",
        "event_payload": {
            "conversation_id": "hart"
        }
    }
}
```

***

### delete\_conversation\_success

When a conversation is deleted, the server sends an event called `delete_conversation_success.`&#x20;

This event provides confirmation that the deletion has happened.

**Emit: No**\
**Receive:** Yes\
**Payload:**&#x20;

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "delete_conversation_success",
        "event_payload": {
            "userId": "hart",
            "conversation_id": "hart_0bf45c1c-dbf7-4ece-ac17-abb2a41e160b"
        }
      }
}
```

***

### metadata\_request

This action retrieves the metadata for a specific conversation using the conversation's unique ID (`idChat`).&#x20;

**Emit: Yes**\
**Receive: Yes**\
**Payload:**&#x20;

```javascript
{
    "action": "sendMessage",
    "event": {
        "event_type": "metadata_request",
        "event_payload": {
            "conversation_id": "6f61b997-6e2c-471e-8481-27a584c5dcdc"
        }
    }
}
```

***

### conversation\_transcript

The returned transcript in response to `conversation_transcript_request` even&#x74;*.*

**Emit** : No\
**Receive** : Yes\
**Payload** :

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "conversation_transcript",
        "event_payload": {
            "conversation_id": "hart_acb3b13e-4818-40fa-b57e-d8a80feba5c1",
            "transcript": [
                {
                    "event_id": "event id",
                    "messages": [
                        {
                            "actions": [], // if there are actions
                            "files": [], // if there are files
                            "from": "user || chatbot || livechat",
                            "chatbotName": "Name of chatbot in your hub if there is",
                            "channelName": "Name of channel in your hub",
                            "livechatName": "Name of livechat in your hub if there is",
                            //Array of chronological message contents
                            "messages": [
                                {
                                    "type": "text || buttons || cards",
                                    "text": "Actual message if type is text",
                                    "buttons": {
                                        // buttons if type is buttons
                                        "title": "Choose from the following:",
                                        "options": [
                                            {
                                                "label": "button label 1",
                                                "value": "button value 1"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "event_id": "WvVB-EB6rPEFkJQ=",
        "accepts_response_payload": false
    }
}
```

**Payload example with user, agent, and bot messages:**

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "conversation_transcript",
        "event_payload": {
            "conversation_id": "hart_acb3b13e-4818-40fa-b57e-d8a80feba5c1",
            "messages": [
                {
                    "from": "user",
                    "messages": [{ "type": "text", "text": "hello" }],
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "bot",
                    "messages": {
                        "idChat": "hart_acb3b13e-4818-40fa-b57e-d8a80feba5c1",
                        "messages": [
                            {
                                "text": "Hi. I'm the Captivate Bot.",
                                "type": "text"
                            }
                        ],
                        "actions": []
                    },
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "user",
                    "messages": [{ "type": "text", "text": "agent" }],
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "bot",
                    "messages": {
                        "idChat": "hart_acb3b13e-4818-40fa-b57e-d8a80feba5c1",
                        "messages": [
                            {
                                "text": "Please wait while I connect you to the support team.",
                                "type": "text"
                            }
                        ],
                        "actions": [
                            { "type": "normal", "title": "escalateToHuman" }
                        ]
                    },
                    "actions": [
                        { "type": "normal", "title": "escalateToHuman" }
                    ],
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "user",
                    "messages": [{ "type": "text", "text": "hello" }],
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "user",
                    "messages": [{ "type": "text", "text": "hello" }],
                    "channelName": "test custom channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                },
                {
                    "from": "agent ",
                    "messages": {
                        "idChat": "hart_acb3b13e-4818-40fa-b57e-d8a80feba5c1",
                        "messages": [
                            {
                                "type": "text",
                                "text": "Our agents are currently busy at the moment."
                            }
                        ],
                        "actions": []
                    },
                    "channelName": "custom-channel",
                    "chatbotName": "AWS-LEX-QORBITAL-DEMO"
                }
            ]
        },
        "event_id": "WvVB-EB6rPEFkJQ=",
        "accepts_response_payload": false
    }
}
```

***

### conversation\_update

Updates specific to a conversation session. Details for updates types will be provided in the next documents.&#x20;

Emit : No \
Receive : Yes \
Payload :

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "conversation_update",
        "event_payload": {
            "type": "failedAgentAssignment || livechatAgentConnected || livechatAgentDisconnected",
            "conversation_id": "Captivate Hub Session ID",
            "data": {} // data relevant to the type of conversation update, for example, if update is livechatAgentConnected, then this would contain the agentInfo
        }
    }
}
```

***

### general\_error

Sent during errors.

Emit : No \
Receive : Yes \
Payload <br>

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "conversation_update",
        "event_payload": {
            "event_type": "general_error",
            "event_payload": {
                "conversation_id": "Conversation ID",
                "error_code": "Error code",
                "error_desc": "Error Description"
            },
            "event_id": "event_id"
        }
    }
}
```

**Example –** at the moment, this Invalid conversation\_Id is the only possible error returned.

```javascript
{
    "action": "receiveMessage",
    "event": {
        "event_type": "general_error",
        "event_payload": {
            "conversation_id": "sasa-5beb-4a96-a0d6-8c3369e82627",
            "error_code": 400,
            "error_desc": "Invalid conversation_id"
        },
        "event_id": "WJ8pqG9gLPEF9ng=",
        "accepts_response_payload": false
    }
}
```


# Socket Conversation Testing

Test the functionality of your Custom Channel with our Socket Tester.

We created a **Socket Conversation Testing** environment where you can plug in your existing Custom Channel and test Endpoints if they are currently working as intended.&#x20;

You may access the **Socket Conversation Testing** site [here](https://captivatechat.github.io/widget-test/socket/sockets.html).

{% hint style="warning" %}
**REMINDER**

These WebSocket Endpoints are advisable to be used by developers familiar with the product or service you want to transform into a Custom Channel.&#x20;

Please provide this page to them so they can conduct proper testing with the Custom Channel you want to create.
{% endhint %}

***

## Socket Conversation Testing

<figure><img src="/files/4yF6DID0AtHYAzsrtE59" alt="Opening the Socket Conversation Testing webpage reveals this webpage. It has instructions on how to use this testing environment. The section to the right is where users can plug in their WSS URL with the API Key to access their Custom Channel, a JSON textbox for their WebSocket Endpoints, and Send Message to test them. There is an empty box below that will be filled with the Chatbot&#x27;s response."><figcaption><p>Opening the Socket Conversation Testing webpage reveals this webpage. It has instructions on how to use this testing environment. The section to the right is where users can plug in their WSS URL with the API Key to access their Custom Channel, a JSON textbox for their WebSocket Endpoints, and Send Message to test them. There is an empty box below that will be filled with the Chatbot's response.</p></figcaption></figure>

This is the **Socket Conversation Testing** website that is accessible via the URL above. It reveals a simple webpage where developers can test their existing Custom Channel's functionalities.&#x20;

It is comprised of three sections:

* **Instructions:** The left side contains instructions on how to use this webpage.
* **Choose an Action:** This is the active testing area. It has these components:
  * **WSS URL:** This is the unique URL of your Custom Channel. It contains your API key.
  * **Enter your JSON here...:** This textbox is where you will plug in WebSocket Endpoints listed in the Instructions to test your Custom Channel.
* **Response Area:** This is the white area below the *Send Message* button where your Custom Channel should respond.

***

## Open Socket Connection

<figure><img src="/files/25YsbZ3kWZ9ZEIlxRK7H" alt=""><figcaption></figcaption></figure>

Before you can use the Socket Conversation Testing page, you need to plug in your Custom Channel first. You do this within the **WSS URL** textbox below *Choose an Action*.

You have to copy a WSS URL into the text box.

If you're using it for **production:**

```
wss://channel.wss.captivatechat.ai/dev?apiKey=API_KEY
```

If you're using it for **development:**

```
wss://channel-dev.wss.captivatechat.ai/dev?apiKey=API_KEY
```

Take note that `API_KEY` here corresponds to the API Key you will receive when you create a Custom Channel in [Channel: Custom Channel](/start-creating/create-a-chat-flow/select-channel/channel-custom-channel)

After doing so, click ***Open Socket Connection***. If your Custom Channel is working, you should get a `socket_connected` event.

***

## Test with Client Actions

<figure><img src="/files/5ydAkpTJMuI6OJfjT15S" alt="This &#x22;Enter your JSON here...&#x22; textbox in the Socket Conversation Testing  is where you have to input events in JSON format. When you click &#x22;Send Message&#x22;, you should receive a response appropriate to the expected outcome as indicated in the &#x22;Instructions&#x22; segment of the Socket Conversation Testing page."><figcaption><p>This "Enter your JSON here..." textbox in the Socket Conversation Testing  is where you have to input events in JSON format. When you click "Send Message", you should receive a response appropriate to the expected outcome as indicated in the "Instructions" segment of the Socket Conversation Testing page.</p></figcaption></figure>

After you connected your WSS URL, your Custom Channel will be responsive to your **events**. You can test them by plugging them into the *"Enter your JSON here..."* textbox, customizing its parameters, and clicking ***Send Message***.&#x20;

<figure><img src="/files/332yBWMVSiKiCs25dAIw" alt="The empty box below the &#x22;Enter your JSON here...&#x22; textbox will return a response after you click &#x22;Send Message.&#x22;"><figcaption><p>The empty box below the "Enter your JSON here..." textbox will return a response after you click "Send Message."</p></figcaption></figure>

When the empty box below the *"Enter your JSON here..."* textbox returns a response appropriate to your event, then it is working as intended.

***

## Client Actions

<figure><img src="/files/bKckiqtNX948H2HbzTTC" alt="An example of a Client Action listed in the Socket Conversation Testing webpage. Plug them into the &#x22;Enter your JSON here...&#x22; textbox, customize its parameters, and click &#x22;Send Message&#x22; to check if your Custom Channel can interpret it properly."><figcaption><p>An example of a Client Action listed in the Socket Conversation Testing webpage. Plug them into the "Enter your JSON here..." textbox, customize its parameters, and click "Send Message" to check if your Custom Channel can interpret it properly.</p></figcaption></figure>

The Socket Conversation Testing webpage has a list of **Client Actions** you can copy and paste into the *"Enter your JSON here..."* textbox for testing. You can customize its parameters before clicking *"Send Message."*&#x20;

The response in the white box below will determine if your Custom Channel is working properly.


# Select Live Chat Vendor

<figure><img src="/files/KuXi7YwpYcxs1rLvsa49" alt="The &#x22;Select Live Chat Vendor&#x22; screen allows users to select their preferred Live Chat to connect customers to agents."><figcaption><p>The "Select Live Chat Vendor" screen allows users to select their preferred Live Chat to connect customers to agents.</p></figcaption></figure>

After deciding on your AI Chatbot and connecting your Channel, you can now choose your **Live Chat** in the ***Step 3: Select Live Chat Vendor*** page. This determines what internal messaging platform your will use to connect your Live Agents to your customers.

Doing this will make this specific Chat Flow visible to the Captivate Chat app in the Live Chat service you selected. It won't be visible in unselected platforms.&#x20;

{% hint style="warning" %}
**This step won't connect the Live Chat service to your Chat Flow yet!**&#x20;

You can only assign a Live Chat service to your Chat Flow in *"Step 3: Select Live Chat Vendor".*

This step **only ensures your Chat Flow is recognized by the Live Chat service you selected.**
{% endhint %}

{% hint style="warning" %}
**Connect your Live Chat service to your Chat Flow in a different process!**

In order to connect your Live Chat service to this Chat Flow, you have to follow a specific process outside of the Captivate Chat platform.&#x20;

There are specific instructions to connect Captivate Chat within the MS Teams app, and different instructions to connect Captivate Chat to the Slack program.&#x20;
{% endhint %}


# Modify your Chat Flow

Edit the parameters of your Chat Flows

<figure><img src="/files/ck4gjU2Po1ctmSGFeEG2" alt="The Setup > Chat Flows view presents all available Chat Flows that the user created."><figcaption><p>The Setup > Chat Flows view presents all available Chat Flows that the user created.</p></figcaption></figure>

<figure><img src="/files/iLT7gQrxPhVJVACMBBFP" alt="The Setup > Chat Flows view presents all available Chat Flows that the user created."><figcaption><p>The Setup > Chat Flows view presents all available Chat Flows that the user created.</p></figcaption></figure>

After you create your Chat Flow, you will return to the ***Setup > Chat Flows*** view. Your newest Chat Flow will be displayed as the first tile from the top of your list.

You can maintain an existing Chat Flow through these steps:

***

## Modify a Chat Flow using settings

<figure><img src="/files/oJiUrhSpbNOjPi9r1YhY" alt="Clicking the hamburger menu beside any Chat Flow allows users to edit, rename, and delete them."><figcaption><p>Clicking the hamburger menu beside any Chat Flow allows users to edit, rename, and delete them.</p></figcaption></figure>

<figure><img src="/files/jbW9dveyETC2JRLNwKf1" alt="Clicking the hamburger menu beside any  Chat Flow allows users to edit, rename, and delete them."><figcaption><p>Clicking the hamburger menu beside any Chat Flow allows users to edit, rename, and delete them.</p></figcaption></figure>

You can modify your Chat Flow by **clicking settings (** ![The hamburger icon in the Captivate Chat's Setup > Chat Flows view reveals modification options for the Chat Flow.](/files/KST6nVMhsZouA9SL5Nug) **)** and choosing an action you want accomplish:&#x20;

* **Edit Chat Flow:** Adjust all parameters of the Chat Flow.
* **Rename Chat Flow**
* **Delete**

### Select what you want to edit

<figure><img src="/files/MlDGEsO5IZmwvVnqE4GV" alt=""><figcaption></figcaption></figure>

If you click ***Edit*** in the drop down selector of your Chat Flow, you will be asked to pick which part of the Chat Flow you specifically want to change:

* **Chatbot:** If you just want to edit the Chatbot.
* **Channel:** If you just want to modify the Channel.
* **Livechat:** If you just want to reconfigure the Live Chat.
* **All:** If you want to edit all parts of the Chat Flow.

Your choice of the above determines which menus appear in the Chat Flow editing stage.

***

## Delete a Chat Flow

You can delete a Chat Flow using these steps:

### Clicking settings

<figure><img src="/files/01mbLWfoXaCmAarp9hRw" alt="The &#x22;Delete&#x22; is highlighted among the drop downs of a Chat Flow&#x27;s hamburger menu settings. Clicking this permanently deletes the specified Chat Flow."><figcaption><p>The "Delete" is highlighted among the drop downs of a Chat Flow's hamburger menu settings. Clicking this permanently deletes the specified Chat Flow.</p></figcaption></figure>

<figure><img src="/files/JWJ6T1ruFnPrLrCYMHqi" alt="The &#x22;Delete&#x22; is highlighted among the drop downs of  a Chat Flow&#x27;s hamburger menu settings. Clicking this permanently deletes the specified Chat Flow."><figcaption><p>The "Delete" is highlighted among the drop downs of a Chat Flow's hamburger menu settings. Clicking this permanently deletes the specified Chat Flow.</p></figcaption></figure>

You can delete your Chat Flow by **clicking settings (** ![The hamburger icon in the Captivate Chat's Setup > Chat Flows view reveals modification options for the Chat Flow.](/files/KST6nVMhsZouA9SL5Nug) **)** and choosing ***Delete*** from the options.

### Using the checkbox to delete a Chat Flow

<figure><img src="/files/sARK9b7oDrsDIwI0iXBG" alt="A sample Chat Flow named &#x22;DemoAgentFlow&#x22; is selected via a checkbox beside it. Clicking &#x22;Delete&#x22; while &#x22;Facebook Test&#x22; is ticked will only delete this specific Chat Flow."><figcaption><p>A sample Chat Flow named "DemoAgentFlow" is selected via a checkbox beside it. Clicking "Delete" while "Facebook Test" is ticked will only delete this specific Chat Flow.</p></figcaption></figure>

<figure><img src="/files/LuVS29bQzap6vW5Ng0dn" alt="A sample Chat Flow named &#x22;Facebook Test&#x22; is selected via a checkbox beside it. Clicking &#x22;Delete&#x22; while &#x22;Facebook Test&#x22; is ticked will only delete this specific Chat Flow."><figcaption><p>A sample Chat Flow named "Facebook Test" is selected via a checkbox beside it. Clicking "Delete" while "Facebook Test" is ticked will only delete this specific Chat Flow.</p></figcaption></figure>

You can also delete your Chat Flow by **clicking the checkbox (** ![This specific blue checkbox in Setup > Chat Flows view will select the Chat Flow beside it.](/files/Pqwc3MSmKPwgkyTJngGQ) **)** and choosing ***Delete*** beside ***+Chat Flow***.&#x20;

### Using the checkbox to delete many Chat Flows

<figure><img src="/files/sIeZKHM1Q73OzGYX7Hgb" alt="Multiple blue checkboxes can be ticked. When done, it selects the Chat Flows beside them. Clicking &#x22;Delete&#x22; after ticking the checkboxes of more than one Chat Flow will delete all ticked Chat Flows."><figcaption><p>Multiple blue checkboxes can be ticked. When done, it selects the Chat Flows beside them. Clicking "Delete" after ticking the checkboxes of more than one Chat Flow will delete all ticked Chat Flows.</p></figcaption></figure>

<figure><img src="/files/rdyONA8s9aP2T97kt0gv" alt="Multiple blue checkboxes can be ticked. When done, it selects the Chat Flows beside them. Clicking &#x22;Delete&#x22; after ticking the checkboxes of more than one Chat Flow will delete all ticked Chat Flows."><figcaption><p>Multiple blue checkboxes can be ticked. When done, it selects the Chat Flows beside them. Clicking "Delete" after ticking the checkboxes of more than one Chat Flow will delete all ticked Chat Flows.</p></figcaption></figure>

You can delete more than one Chat Flows by **clicking the checkbox (** ![This specific blue checkbox in Setup > Chat Flows view will select the Chat Flow beside it.](/files/Pqwc3MSmKPwgkyTJngGQ) **)** for the Chat Flows you want to remove. To delete them permanently, simply click ***Delete*** beside ***+Chat Flow***.

<figure><img src="/files/AGKwq4TB5vreQZjiiG3A" alt="Clicking the blue checkbox beside the &#x22;Chat Flow&#x22; word will select all Chat Flows in the screen by ticking their checkboxes. "><figcaption><p>Clicking the blue checkbox beside the "Chat Flow" word will select all Chat Flows in the screen by ticking their checkboxes. </p></figcaption></figure>

<figure><img src="/files/Y73wIn8ghQ2EAKe6NLz4" alt="Clicking the blue checkbox beside the &#x22;Chat Flow&#x22; word will select all Chat Flows in the screen by ticking their checkboxes. "><figcaption><p>Clicking the blue checkbox beside the "Chat Flow" word will select all Chat Flows in the screen by ticking their checkboxes. </p></figcaption></figure>

You can delete all of your existing Chat Flows by **clicking** ![Clicking the blue checkbox beside the "Chat Flow" word will select all Chat Flows in the screen by ticking their checkboxes. ](/files/hJ2ErAB5lZT4SZ2cZDlf) , which then selects all your available Chat Flows. To delete them permanently, simply click ***Delete*** beside ***+Chat Flow***.

### Deletion final warning

<figure><img src="/files/2LsrJn9yz4XqR6WUCJaY" alt=""><figcaption></figcaption></figure>

You will receive a final warning if you want to delete your Chat Flow. This is because Chat Flow deletion is permanent and irreversible.&#x20;


# Connect a Live Chat

Instruct your AI Chatbots to connect your Channel users to a Live Chat

You can use your Chat Flow to connect users of your Channels (Facebook, Instagram, WhatsApp, Web Widget) to your agents in a Live Chat service.

After setting up your Chat Flow, you can connect it to a **Live Chat** service so your live agents can talk to users if they have concerns. We currently have Live Chat setups available for:

* MS Teams
* Slack

&#x20;


# Microsoft Teams

Connect your Chat Flow to Microsoft Teams

Once you’ve prepared your Chat Flow with an AI Chatbot and a Channel of your choice, connecting it to your Microsoft Teams account can be accomplished in just a few steps.&#x20;

{% hint style="info" %}
**SUMMARY**

Adding a Chat Flow to your MS Teams can be done in the following steps:

1. **Install the Captivate Chat MS Teams App:** This is the Captivate Chat app within Microsoft Teams those controls connected Chat Flows using special functions.
2. **Grant permissions to the Captivate Chat MS Teams App:** Your first sign in will involve granting permission to the Captivate Chat MS Teams App to access your MS Teams channel.
3. **Sign in to Captivate Chat in the Captivate Chat MS Teams App:** When you open the MS Teams app, it will take you to a sign in process.
4. **Link your Chat Flow:** Upon signing in to the Captivate Chat MS Teams App, type `"link"` to connect a Chat Flow. Click your chosen Chat Flow from a drop-down list.
5. **Confirm new MS Teams chats:** When you choose a Chat Flow, your MS Teams should create a new group chat named after your Chat Flow, and a new group chat with your name as an agent.&#x20;
6. **Test your integration:** Go to your Channel, talk to your AI Chatbot, and ask to be assigned to an agent. Your MS Teams will be notified of this request, a new chat named after the user will be created, and this new chat will be updated with the conversation that is happening in the Channel.&#x20;
   {% endhint %}

{% hint style="danger" %}
**REQUIREMENTS**

Before trying to link your Chat Flows to your Microsoft Teams, here are some requirements you should consider:

* **Chat Flow set to MS Teams Live Chat:** You should choose "MS Teams" as your Live Chat while setting up your Chat Flow. This makes it detectable in the Captivate Chat MS Teams App. Do this in *"Step 3: Select Live Chat Vendor"* in the Chat Flow creation process.&#x20;
* **Microsoft Teams channel:** Your company must have a Microsoft Teams channel.&#x20;
* **Identical Microsoft Teams and Captivate Chat email:** The Captivate Chat MS Teams App under your MS Teams email can only access Chat Flows created by the Captivate Chat of your same email.&#x20;
* **Captivate Chat MS Teams App:** You have to install the Captivate Chat MS Teams App. It's available in your MS Teams Apps page.
  {% endhint %}

{% hint style="warning" %}
**A Channel in Captivate Chat is different than the "channel" in Microsoft Teams**

In this particular section of the guide, you might encounter the word `channel`used by both Captivate Chat and Microsoft Teams.

**Channels** in Captivate Chat pertain to avenues where an AI Chatbot is deployed - whether web widget or social media.&#x20;

Meanwhile, **channels** in Microsoft Teams pertain to chat groups for organizations.&#x20;

**To avoid confusion**, we will be spelling "channels" for Microsoft Teams in small caps, and "Channels" for Captivate Chat in large caps.&#x20;
{% endhint %}

##


# Set up the Captivate Chat MS Teams App

<figure><img src="/files/lXzJiVSlI7icNQBKHo3i" alt=""><figcaption><p>A blank MS Teams page.</p></figcaption></figure>

Before you connect your Chat Flow to your MS Teams, you need to install the **Captivate Chat MS Teams App**.&#x20;

Log into your Microsoft Teams.&#x20;

<figure><img src="/files/TSmWzSDImOhajM7Z2mDY" alt="The &#x22;Apps&#x22; in Microsoft Teams is located on the lower-right side of the main toolbar."><figcaption><p>The "Apps" in Microsoft Teams is located on the lower-right side of the main toolbar.</p></figcaption></figure>

On the left-side toolbar, click ***Apps***.&#x20;

A new window will load that contains available applications you can integrate to your Microsoft Teams.&#x20;

<figure><img src="/files/IaOxKLj44q1BTEkki2xp" alt="Search for &#x22;Captivate Chat&#x22; in the Apps page to reveal the Captivate Chat MS Teams App. Click &#x22;Add&#x22; to install it."><figcaption><p>Search for "Captivate Chat" in the Apps page to reveal the Captivate Chat MS Teams App. Click "Add" to install it.</p></figcaption></figure>

On the search bar, look for `"Captivate Chat"`.

Wait for the screen to load. An app called Captivate Chat should appear and look like the one in the picture above. Click ![The MS Teams App store has the "Add" button to install the Captivate Chat MS Teams App to your organization's MS Teams](/files/F5Hj9Ijr6B9RMiHiUZNQ) on the upper right side of the application.&#x20;

<figure><img src="/files/xFCHb3rMudrpRJ4d4FQm" alt="The app view of the Captivate Chat MS Teams App. It has a purple version of the &#x22;Add&#x22; button that installs it to your MS Teams."><figcaption><p>The app view of the Captivate Chat MS Teams App. It has a purple version of the "Add" button that installs it to your MS Teams.</p></figcaption></figure>

This will open a pop-up window containing the application page.

Proceed with the installation by clicking ![Purple version of the "Add" button in MS Teams App Store that installs the Captivate Chat MS Teams App to your organization's MS Teams](/files/tzOwRuWSi6OIr4tpK3PS) below the name.&#x20;

As the app is installed, this button transforms into ![When you click the "Add" button of the Captivate Chat MS Teams App in the Apps Store, it becomes "Adding" during installation.](/files/VZsoug8NUag8FBA2hcAp).&#x20;

<figure><img src="/files/zxkqcI93ceQYm9qIs99p" alt="The Captivate Chat MS Teams App opens a new window when successfully installed. Under &#x22;Select a Channel,&#x22; select your MS  Teams organization. Click the purple &#x22;Open&#x22; button to launchh the app."><figcaption><p>The Captivate Chat MS Teams App opens a new window when successfully installed. Under "Select a Channel," select your MS  Teams organization. Click the purple "Open" button to launchh the app.</p></figcaption></figure>

Once complete, a new window will appear. Click ![The purple "Add" button of the Captivate Chat MS Teams App that becomes "Adding" during installation will become a purple "Open" after the app is installed. Press "Open" to open the Captivate Chat MS Teams App. ](/files/LQV1BLIMSHBhXskvj5Bd).

A chat window for Captivate Chat will appear. This is Captivate Chat’s own dedicated app for MS Teams integration.

{% hint style="info" %}
**Choose the Microsoft Teams channel where you want the app to be used!**

Microsoft Teams allows you to open the Captivate Chat MS Teams App to be opened across different "channels."&#x20;

Select your preferred channel, especially if you have different Microsoft Teams organizations.
{% endhint %}


# MS Teams App Chat Prompts

<figure><img src="/files/L2JgR094yUxNNJ6dH6UB" alt="The view of the Captivate Chat MS Teams App when opened. There are various commands that players can type such as Start, Signin, Signout, Link, Unlink, and Help."><figcaption><p>The view of the Captivate Chat MS Teams App when opened. There are various commands that players can type such as Start, Signin, Signout, Link, Unlink, and Help.</p></figcaption></figure>

With the Captivate Chat MS Teams App, you can start linking and unlinking Chat Flows directly into the Microsoft Teams of your organization. You can do these, among other things, through the built-in **prompts** in the app.

When you start a conversation with the Captivate Chat MS Teams App, you can perform various actions through its different prompts:

## Help

<figure><img src="/files/3XImAVb9FP1QHyaGcArY" alt="Typing &#x22;Help&#x22; in the Captivate Chat MS Teams App  will send the list of commands and their basic functions."><figcaption><p>Typing "Help" in the Captivate Chat MS Teams App will send the list of commands and their basic functions.</p></figcaption></figure>

`help` provides the list of all prompts you can use within the app.

## Start

`start` is best used if you open the Captivate Chat app for the first time and the Chatbot didn't initiate a conversation. You have two (2) options:

### If you are not logged in

<figure><img src="/files/ReO9swQZW9Ij4HrRzzJ1" alt="Typing &#x22;Start&#x22; will walk users through the process of using the Captivate Chat MS Teams App."><figcaption><p>Typing "Start" will walk users through the process of using the Captivate Chat MS Teams App.</p></figcaption></figure>

Typing `start` if you are not logged in will provide this window. This process is identical to the `signin` command.

{% hint style="info" %}
**When is it best to use the** `start` **command?**

If you're using the Captivate Chat MS Teams App for the first time, you will usually get sent straight to `signin`.&#x20;

However, `start` is useful if the app didn't load anything after being opened.&#x20;
{% endhint %}

### If you are logged in

<figure><img src="/files/ehiIdcdpUfsRR1P6NTtJ" alt="Typing &#x22;start&#x22; while the user is already logged in will immediately prompt them with a drop down to choose a Chat Flow to connect to their MS Teams organization."><figcaption><p>Typing "start" while the user is already logged in will immediately prompt them with a drop down to choose a Chat Flow to connect to their MS Teams organization.</p></figcaption></figure>

Typing `start` if you are already logged in will provide this window. This process is identical to the `link` command.

## Signin

<figure><img src="/files/UcWCYV9TetfJNlAFPpZG" alt="Typing &#x22;start&#x22; while the user is not logged in the Captivate Chat MS Teams App will prompt the sign-in process. Options after typing &#x22;start&#x22; when signed out include a &#x22;Sign Up&#x22; to register for an account, &#x22;Sign in via Teams&#x22; to log in via the MS Teams account already logged in the system, &#x22;Sign via Web&#x22; to open a browser for sign-up, and &#x22;Help&#x22; for other options."><figcaption><p>Typing "start" while the user is not logged in the Captivate Chat MS Teams App will prompt the sign-in process. Options after typing "start" when signed out include a "Sign Up" to register for an account, "Sign in via Teams" to log in via the MS Teams account already logged in the system, "Sign via Web" to open a browser for sign-up, and "Help" for other options.</p></figcaption></figure>

`signin` will prompt Captivate Chat to log you into your Captivate Chat account. You can do this in different ways:

### Sign in via Teams

<figure><img src="/files/lcENIdCJiDzr1L9SGpcs" alt="After typing &#x22;signin&#x22; while logged out and choosing  &#x22;Sign in via Teams,&#x22; a purple &#x22;Link&#x22; button appears."><figcaption><p>After typing "signin" while logged out and choosing  "Sign in via Teams," a purple "Link" button appears.</p></figcaption></figure>

Clicking ![Purple "Sign in via Teams" button appears after typing "signin" in the Captivate Chat MS Teams App](/files/nC74K8YjNnvR9J1UDpt2) will prompt the app to check if your Microsoft Teams email is connected to an existing Captivate Chat account.&#x20;

If this is the case, the Captivate Chat MS Teams App will make an automatic connection.

### Sign up

<figure><img src="/files/NSNz2SBGhVhRAnpsrLsK" alt="After typing &#x22;signin&#x22; while logged out and choosing &#x22;Sign up,&#x22; a prompt to open the browser appears . Click the purple &#x22;Yes&#x22; button to proceed."><figcaption><p>After typing "signin" while logged out and choosing "Sign up," a prompt to open the browser appears . Click the purple "Yes" button to proceed.</p></figcaption></figure>

Click ![White "sign up" button that appears when users type "signin" in the Captivate Chat MS Teams App will prompt users to register for a Captivate Chat account online. ](/files/hulPCBjZ0xeBidC29bY8) if you don't have a Captivate Chat account.&#x20;

You will be asked to allow Captivate Chat to open a new window. Click ![Purple "Yes" button that appears when users click "Sign up" in the Captivate Chat MS Teams App. This takes them to an external browser where they can register for a Captivate Chat account. ](/files/1IbK3jlibMKt6IHW9lK9) and follow the registration instructions.

### Sign in via Web

<figure><img src="/files/MgSePkz88xVcM2tl2SrB" alt="Clicking &#x22;Sign in via Web&#x22; after typing &#x22;signin&#x22; while logged out will prompt a request to open a browser window. Click the purple &#x22;Yes&#x22; button to proceed."><figcaption><p>Clicking "Sign in via Web" after typing "signin" while logged out will prompt a request to open a browser window. Click the purple "Yes" button to proceed.</p></figcaption></figure>

Click ![White "Sign in via Web" button leads users to sign in to their Captivate Chat account using a web browser. This appears when users type "signin" in the Captivate Chat MS Teams App while logged out.](/files/h4Pil3OBcAYgF9sTIkeb) to log in to Captivate Chat directly from your web browser.&#x20;

You will be asked if the Captivate Chat will be allowed to open a browser window. Click ![This purple "Yes" button that appears after clicking "Sign in via Web" will open a browser that lets users log in to their Captivate Chat account.](/files/1IbK3jlibMKt6IHW9lK9) and follow the login instructions.

## Link

<figure><img src="/files/BhzGFxUBxyu79aHisThj" alt="Typing &#x22;link&#x22; in the Captivate Chat MS Teams App with a logged in account will reveal a prompt to link a Chat Flow. "><figcaption><p>Typing "link" in the Captivate Chat MS Teams App with a logged in account will reveal a prompt to link a Chat Flow. </p></figcaption></figure>

`link` allows you to connect a Chat Flow to your Microsoft Teams organization.

After entering the command, wait for our Chatbot's response. Click ![Click the purple "Link" button in the Captivate Chat MS Teams App to start the process of loading available Chat Flows for linking to MS Teams.](/files/AIoXu8wwRtGjP64Ah8Mh). This prompts a new message that lets you choose a Chat Flow from a drop-down menu.&#x20;

Once you've made your choice, click ![A purple "Submit" button is clickable after users click the purple "Link" button, which only appears if they type "link" with a logged in account in Captivate Chat MS Teams App. After selecting a Chat Flow to connect to MS Teams, click this purple "Submit" button to submit the Chat Flow for linking to MS Teams.](/files/tyiVG0oNRQJpA37ImGYE). Wait for a few seconds for Captivate Chat to connect your Chat Flow to your Microsoft Teams organization.&#x20;

{% hint style="warning" %}
**Only Chat Flows with MS Teams selected as Live Chat can be integrated**

Users can only see and choose Chat Flows that have MS Teams set as their Live Chat in their Captivate Chat MS Teams App.&#x20;
{% endhint %}

{% hint style="info" %}
**Connect any number of Chat Flows into your Microsoft Teams organization**

You can use Captivate Chat to connect Chat Flows into your Microsoft Teams organization. That way, AI Chatbots in different Channels (like your website, social media) can ask for live agents directly via Captivate Chat.&#x20;
{% endhint %}

## Unlink

<figure><img src="/files/bzP4mbw8sHlRNwYnslUh" alt="Typing &#x22;unlink&#x22; in the Captivate Chat MS Teams App will prompt the user to select an existing connected Chat Flow to be unlinked to MS Teams."><figcaption><p>Typing "unlink" in the Captivate Chat MS Teams App will prompt the user to select an existing connected Chat Flow to be unlinked to MS Teams.</p></figcaption></figure>

`unlink` removes the connection between Microsoft Teams and your chosen Chat Flow.

After sending this prompt, Captivate Chat will ask you to choose **a combination of Team and Chat Flow** you want to unlink.&#x20;

Once you've made your choice, click ![This purple "Submit" button appears when users type "unlink" in the Captivate Chat MS Teams App. After selecting the existing linked Chat Flow from the drop-down link, clicking this purple "Submit" button will unlink the Chat Flow to MS Teams. ](/files/8Ijfk33KSsjXJNADJt6G).

## Signout

<figure><img src="/files/tIO0ShA2fv7gulZwWhN0" alt="Typing &#x22;signout&#x22; in Captivate Chat MS Teams App will sign out the user from their account."><figcaption><p>Typing "signout" in Captivate Chat MS Teams App will sign out the user from their account.</p></figcaption></figure>

`signout` logs you out of your Captivate Chat account.&#x20;

After typing the prompt, simply wait for a few seconds for the chatbot to respond.


# Connect your Captivate Chat account

<figure><img src="/files/n9j9VyyysW0Y7PxxkerC" alt="Opening the Captivate Chat MS Teams App for the first time will walk users through a sign-in process. They will be prompted to agree to terms and conditions and sign in using their preferred method."><figcaption><p>Opening the Captivate Chat MS Teams App for the first time will walk users through a sign-in process. They will be prompted to agree to terms and conditions and sign in using their preferred method.</p></figcaption></figure>

When you open the **Captivate Chat MS Teams App**, you should first log into your Captivate Chat account before you can connect your Chat Flows.

In the textbox of the Captivate Chat MS Teams App, type `signin` to start the login process.

Under the first response, click ![This white "I Agree" button appears when opening Captivate Chat MS Teams App for the first time. Only click this after reading the terms and conditions.](/files/4lafEF6Uoi4CzF2IYqHv). &#x20;

When the second message appears, click ![The purple "Admin Consent" button will appear after players click the white "I Agree" message upon opening Captivate Chat MS Teams App for the first time. They will be taken to a separate page where they will accept permissions. ](/files/Fseq7qnvbsMf4V042nnH).

<figure><img src="/files/Ixgj7ZK6mQWGmuQUjdDL" alt="After clicking the purple &#x22;Admin Consent&#x22; button, a new window opens with a list of permissions that Captivate Chat needs from users."><figcaption><p>After clicking the purple "Admin Consent" button, a new window opens with a list of permissions that Captivate Chat needs from users.</p></figcaption></figure>

A new window will appear. You have to log in to your Captivate Chat account.

After logging in, you will see a permissions request. This will list the things that Captivate Chat MS Teams App needs access to in order to connect Chat Flows to your Teams organizations. &#x20;

Click ![This blue "Accept" button that appears after clicking the purple "Admin Consent" button in the Captivate Chat MS Teams app comes with the permissions that users will be asked to give Captivate Chat in a new window. Click this button to agree.](/files/7SIyskIDyuzbGVQNJSKx).&#x20;

After providing consent, a new message will appear. You will be redirected to your chat in Microsoft Teams.&#x20;

{% hint style="info" %}
**We value your data!**

Captivate Chat won’t sell your information to third-party apps and services.&#x20;
{% endhint %}

<figure><img src="/files/lcENIdCJiDzr1L9SGpcs" alt="After giving Captivate Chat permission to access the user&#x27;s data, they will be taken to a sign in process. They will be asked to either &#x22;Sign up&#x22; to register an account, &#x22;Sign in via Teams&#x22; to log in via their existing account, &#x22;Sign in via Web&#x22; to open a browser to log in, and &#x22;Help&#x22; to view more options."><figcaption><p>After giving Captivate Chat permission to access the user's data, they will be taken to a sign in process. They will be asked to either "Sign up" to register an account, "Sign in via Teams" to log in via their existing account, "Sign in via Web" to open a browser to log in, and "Help" to view more options.</p></figcaption></figure>

Click ![Purple "Sign in via Teams" button appears after typing "signin" in the Captivate Chat MS Teams App](/files/nC74K8YjNnvR9J1UDpt2) .&#x20;

This will prompt the app to check if your Microsoft Teams email is already connected to an existing Captivate Chat account.&#x20;

If this is the case, the Captivate Chat MS Teams App will make an automatic connection.

<br>


# Connect your Chat Flow

<figure><img src="/files/UaWVwQ1RZtknt9MtY1Sz" alt="This white &#x22;Connect your team to a chat flow&#x22; selection appears after users click the purple &#x22;Link&#x22; button in the Captivate Chat MS Teams App. There will be a drop down menu to select Chat Flows."><figcaption><p>This white "Connect your team to a chat flow" selection appears after users click the purple "Link" button in the Captivate Chat MS Teams App. There will be a drop-down menu to select Chat Flows.</p></figcaption></figure>

After logging into your Captivate Chat account via the Captivate Chat MS Teams App, you will be prompted to connect a Chat Flow to Microsoft Teams.&#x20;

Click  ![Click the purple "Link" button in the Captivate Chat MS Teams App to start the process of loading available Chat Flows for linking to MS Teams.](/files/AIoXu8wwRtGjP64Ah8Mh)..

Wait for the response.&#x20;

A new message called ![This white "Connect your team to a chat flow" selection appears after users click the purple "Link" button in the Captivate Chat MS Teams App. There will be a drop down menu to select Chat Flows.](/files/akAUoljLuowR3ihyRHX4) will appear that contains a drop-down list. This has all the Chat Flows you created in Captivate Chat so far.

<figure><img src="/files/ipwAIXgPxH1WHiCUNgeL" alt="After clicking the purple &#x22;Link&#x22; button, a drop down menu appears with a list of Chat Flows that are currently assigned to MS Teams back in Captivate Chat - Setup > Chat Flows."><figcaption><p>After clicking the purple "Link" button, a drop down menu appears with a list of Chat Flows that are currently assigned to MS Teams back in Captivate Chat - Setup > Chat Flows.</p></figcaption></figure>

Choose the Chat Flow you want to connect to your Microsoft Teams account. In this example, we've chosen `"Roof Buddy v2 Chat Flow."`

Click ![A purple "Submit" button is clickable after users click the purple "Link" button, which only appears if they type "link" with a logged in account in Captivate Chat MS Teams App. After selecting a Chat Flow to connect to MS Teams, click this purple "Submit" button to submit the Chat Flow for linking to MS Teams.](/files/8Ijfk33KSsjXJNADJt6G).

It will say ![After submitting a Chat Flow for connection in the Captivate Chat MS Teams Chat via the purple "Link" button, the Captivate Chat MS Teams App will give a message that the linking is ongoing.](/files/1dl0dym1RcWEsbON90ek). Wait for this to finish.&#x20;

<figure><img src="/files/N1IfhWcasY6WXRbN99KM" alt="A &#x22;Chatflow connection created!&#x22; message appears once the user has successfully linked a Chat Flow of their choice to their MS Teams via the Captivate Chat MS Teams App."><figcaption><p>A "Chatflow connection created!" message appears once the user has successfully linked a Chat Flow of their choice to their MS Teams via the Captivate Chat MS Teams App.</p></figcaption></figure>

A new message will say ![After clicking the purple "Submit" button to link the selected Chat Flow in the Captivate Chat MS Teams App, a white "Chatflow connection created!" message appears when the linking process is complete.](/files/3uYRVfE995PLSae71tuh)! This means you’ve finished connecting your Captivate Chat Flow to your Microsoft Teams account.

<figure><img src="/files/MzGPZqJugaUrL3gKeMgn" alt="The view in Captivate Chat - Setup > Chat Flows after MS Teams has been successfully integrated to the Chat Flow via the Captivate Chat MS Teams App"><figcaption><p>The view in Captivate Chat - Setup > Chat Flows after MS Teams has been successfully integrated to the Chat Flow via the Captivate Chat MS Teams App</p></figcaption></figure>

To confirm the connection, go to your Captivate Chat account and check your list of Chat Flows. The Chat Flow you recently connected should have the Microsoft Teams under Live Chat.


# MS Teams App Chats

<figure><img src="/files/LQUzDRAsgmGQ796mHKJT" alt="When users connect a Chat Flow to MS Teams via the Captivate Chat MS Teams App, users should see two new chats in their MS Teams interface."><figcaption><p>When users connect a Chat Flow to MS Teams via the Captivate Chat MS Teams App, users should see two new chats in their MS Teams interface.</p></figcaption></figure>

After you linked your Chat Flow to the Captivate Chat MS Teams App, look at the left-side dashboard of Microsoft Teams.

The app will create these new chat groups:&#x20;

* **Chat Flow Name (Chat Group):** A new chat group with the same name as your Captivate Chat Flow. In the above image, this is `"Roof Buddy v2 Chat Flow"`
* **Agent Name (Live Agent):** This is a conversation dedicated to a Live Agent assigned to respond to users in your Captivate Chat Flow. The first agent is named after you, the creator of the Chat Flow. In the above image, Rob created the Chat Flow so this group chat is named `"CH Agent Rob".`

### **Chat Flow Name**

This is a new chat group with the same name as your Captivate Chat Flow.

The chat group also contains the ***General*** chat. This contains all updates to the Chat Flow. All incoming conversations from users are sent here first before being reallocated to an agent.&#x20;

The General chat is where you can use commands to assign user conversations to Live Agents and make other adjustments to your Chat Flow from the Microsoft Teams side.

### **Agent Name**

This is a chat group dedicated to all user conversations that are transferred to the Live Agent via the Chat Flow. The first agent is named after you, the creator of the Chat Flow. It has the following components:&#x20;

* **General:** All changes that specifically happen to this Live Agent are listed here.&#x20;
* **User Name:** Each user assigned to this Live Agent gets a unique conversation within the chat group. Messages typed here are relayed to the AI Chatbot, which then relays the information to users via their conversation in the Channel.&#x20;

{% hint style="info" %}
**Team members will be notified if they are assigned to chat with a customer**

Team members assigned to an MS Teams Live Chat conversation will see their own Agent Name group chat and a conversation with the user they're assigned to converse with - all in their MS Teams account.&#x20;

This allows team members to have a single reference point of all conversations they've had with your user without having to log into a separate customer service platform.
{% endhint %}

<br>


# Test your Microsoft Teams integration

Now that you’ve successfully integrated your Chat Flow to your Microsoft Teams, you have to test to see if it’s working.&#x20;

In order to do this, you have to do the following:

## **Request for a Live Agent via your Channel**

<figure><img src="/files/VicaPjL321nsZ1j5Hy5J" alt="When you check the Channel of a MS Teams-connected Chat Flow, starting a conversation will reveal a blue &#x22;Chat to person&#x22; link just below their messages."><figcaption><p>When you check the Channel of a MS Teams-connected Chat Flow, starting a conversation will reveal a blue "Chat to person" link just below their messages.</p></figcaption></figure>

Go to the Channel assigned to the Chat Flow you just connected.&#x20;

In this case, we used a Web Widget for `"Roof Buddy v2".`

This means we can preview it straight from the My Chat Flow list in the Captivate Chat website.

{% hint style="info" %}
**Forgot how to preview a Web Widget?**

If you forgot how to preview a Web Widget, refer to [Preview your Web Widget](/start-creating/create-a-chat-flow/select-channel/channel-web-chat/preview-your-web-widget)
{% endhint %}

<figure><img src="/files/0iBeNyktkH0gqad0HWQB" alt="Users can also ask an AI Chatbot to direct them to a Live Agent by saying &#x22;talk to human&#x22; or other similar messages."><figcaption><p>Users can also ask an AI Chatbot to direct them to a Live Agent by saying "talk to human" or other similar messages.</p></figcaption></figure>

Start a conversation with the AI Chatbot assigned to that Channel. Ask for a Live Agent. You can do this using these methods:

* **Type the request directly.** Write `"I want to talk to an agent"` or another derivative you can think of.
* **Click** ![The "Chat to person" link in the Channel of a Chat Flow will allow users to connect to a Live Agent after providing specific requirements.](/files/lLmpfTI2jSkK95087lti)**.** This option is available as a separate command on the Web Widget but can be an interactive button in other Channels (Facebook, Instagram, WhatsApp).

<figure><img src="/files/GhydA5w3G7F5zi8RFklG" alt="After telling the AI Chatbot that the user wants to talk to a Live Agent, the AI Chatbot is instructed to ask them for their name and their email address. This will be sent over to MS Teams."><figcaption><p>After telling the AI Chatbot that the user wants to talk to a Live Agent, the AI Chatbot is instructed to ask them for their name and their email address. This will be sent over to MS Teams.</p></figcaption></figure>

Wait for the AI Chatbot to respond. It will ask you for two (2) things for record-keeping purposes:

* Your name
* Your email address

The AI Chatbot will give a default message asking for the user to wait.

{% hint style="warning" %}
**Use an alternate email for this test!**

When testing your MS Teams integration, make sure you’re using a different email when talking to your AI Chatbot. This allows you to recreate a scenario where a user with a personal email is inquiring to your AI Chatbot about your services.
{% endhint %}

## **Respond to the query via Microsoft Teams**

<figure><img src="/files/Bv1ahgDp1ojwsleqhMGt" alt="The Captivate Chat MS Teams App will provide a notification in the connected Chat Flow&#x27;s General chat that a user wants to connect to a Live Agent."><figcaption><p>The Captivate Chat MS Teams App will provide a notification in the connected Chat Flow's General chat that a user wants to connect to a Live Agent.</p></figcaption></figure>

Go to Microsoft Teams. Wait for the **C*****hat Flow > General*** to receive an update.&#x20;

Since you’re the only Live Agent in your Chat Flow for now, the update will state that the test conversation will automatically be assigned to you.&#x20;

<figure><img src="/files/qlkCHREZmpu3Ti25MQu8" alt="When the new user chat notification appears, clicking it will reveal a text box that agents can reply to in order to respond to the user."><figcaption><p>When the new user chat notification appears, clicking it will reveal a text box that agents can reply to in order to respond to the user.</p></figcaption></figure>

The notification will now contain a text box where you can type a greeting.&#x20;

Greet the user.&#x20;

<figure><img src="/files/QZgnp6d49K30cTXFenaM" alt="Answering the first text box that appears with the new user chat notification will create a new chat under the Agent Name&#x27;s group chat. This will be named after the user who just asked a query. Their conversation will load in this chat, and agentscan reply using this chat."><figcaption><p>Answering the first text box that appears with the new user chat notification will create a new chat under the Agent Name's group chat. This will be named after the user who just asked a query. Their conversation will load in this chat, and agentscan reply using this chat.</p></figcaption></figure>

After greeting the user, Captivate Chat will transition your conversation into a separate chat under your ***Agent Name*** group chat. The new conversation will have the name of the user you're currently talking to.&#x20;

## Check the dialogue in your Channel

<figure><img src="/files/O2owCY9M0r46ehOqZD53" alt="Users will be notified that an agent has joined a conversation. All messages sent by the agent through the Captivate Chat MS Teams App will be sent to users in Channels via the AI Chatbots they are talking to. "><figcaption><p>Users will be notified that an agent has joined a conversation. All messages sent by the agent through the Captivate Chat MS Teams App will be sent to users in Channels via the AI Chatbots they are talking to. </p></figcaption></figure>

Check the Channel to view the conversation between the AI Chatbot and your test user.&#x20;

There should be a message that says `"Agent (Your Name) joins the conversation,"` alongside the greeting you sent over via Microsoft Teams.

## Wait for the MS Teams App to load your current conversation

<figure><img src="/files/149r4yWHVQh1AeJJe1Md" alt="Replies of users to the agent through the AI Chatbot will be sent to the Agent Group Chat > User&#x27;s Chat in the Captivate Chat MS Teams App. "><figcaption><p>Replies of users to the agent through the AI Chatbot will be sent to the Agent Group Chat > User's Chat in the Captivate Chat MS Teams App. </p></figcaption></figure>

Back in Microsoft Teams, wait for the initial conversation between your AI Chatbot and user to load. This should give you enough context about the user’s needs.

Once all the messages have loaded, continue the conversation to test your AI Chatbot. <br>


# Create a Custom Component

Want to create a Custom Component? We've got you covered!

If you want a **specific Custom Component** to incorporate into your business, the Captivate Chat team can certainly help you out!

***

## Contacting Captivate Chat&#x20;

<figure><img src="/files/Kd5FkqycQ85sGMVlwgwz" alt="The &#x22;Add one for me&#x22; button is present in many pages of Captivate Chat. This lets users contact the Captivate Chat team to request for a specific service or product to be created for them that the platform doesn&#x27;t have."><figcaption><p>The "Add one for me" button is present in many pages of Captivate Chat. This lets users contact the Captivate Chat team to request for a specific service or product to be created for them that the platform doesn't have.</p></figcaption></figure>

Whenever we ask you to choose a type of service for your needs (AI Chatbot, Channel, Live Chat), you might encounter an option called ***+Add One for Me.***&#x20;

This lets you send a message to the Captivate Chat team if you want to create something more specific for your needs

You can also access *Add One for Me* through this link: <https://www.captivatechat.ai/add-one-for-me/>

***

## Add One for Me

<figure><img src="/files/yenOoR9Br7sxUEdRUwKK" alt="The &#x22;Add One for Me&#x22; menu has items that users have to fill out in order to provide as much context as possible to the Captivate Chat team. This enables them to work on their dream component much easier."><figcaption><p>The "Add One for Me" menu has items that users have to fill out in order to provide as much context as possible to the Captivate Chat team. This enables them to work on their dream component much easier.</p></figcaption></figure>

Clicking ***+Add One for Me*** or the link will bring you to this window.

Fill up the following information so we can reach out regarding your idea:

* **Basic Information**
  * **First Name**
  * **Last Name**
  * **Organisation**
  * **Website**
  * **Role**
  * **Email**
* **Please Select the Service/s You Require:** Tick the boxes of the kind of component you think fits your idea the best. See our available components below!
* **A Bit More Detail, Please:** Describe the functionality of the tool you want us to create.&#x20;

{% hint style="info" %}
**Be as precise and creative as you want!**

Don't worry if you think your idea might be too "complex" when pitching something in ***Add One for Me.***&#x20;

Feel free to be as elaborate and as creative as you want, especially with the product details. We'll reach out regarding the specifics!&#x20;
{% endhint %}

***

## Available Components

<figure><img src="/files/3PhuWQlJv8rEA2pwXKhD" alt="Users can select a specific service they want Captivate Chat to create for them. They can choose a Channel, AI Assistant, Live Chat, Bespoke AI, or something more specific. They can choose one or multiple options, especially if their software has different functionalities."><figcaption><p>Users can select a specific service they want Captivate Chat to create for them. They can choose a Channel, AI Assistant, Live Chat, Bespoke AI, or something more specific. They can choose one or multiple options, especially if their software has different functionalities.</p></figcaption></figure>

Here are the kinds of custom components our clients often ask us to make:

* **Channel:** If you want your Chatbot to appear in a specific medium, such as an app or a software, you can choose this option.
* **AI Assistant:** Choose this if you want a specific type of AI Chatbot outside our available templates.
* **Live Chat:** If your company has a specific software or product that facilitates your Live Chats, you can choose this option.
* **Bespoke AI:** Select this If the AI tool you designed doesn't fit "quite right" in the context of being an AI Assistant.
* **Other:** Choose this if you have a specific functionality or software in mind that doesn't fall under the previous categories. Examples include:
  * **AI Platform:** Do you have a preferred AI Platform aside from IBM Watson, AWS Lex, and OpenAI?&#x20;


# SUPPORT

Need assistance with anything? We're here to help!

## Contact Details

If you want to get in touch with the **Captivate Chat** team, you may do so through the following channels:

✉️ **Email:** <info@captivatechat.com>

📞 **Mobile:** +44 (0) 20 4538 2554

🗺️ **Office:** 147 Station Road North Chingford London, E4 6AG

***

## For Specific Concerns

Do you have any specific concerns? Please check out different ways to contact our team below:&#x20;

### Support

For immediate customer support, you may reach out to us via our email:

📩 **Support Email:** <support@captivatechat.com>

### Component Request&#x20;

If you have a specific component request, please get in touch with our general support team via:&#x20;

📩 **Info Email:** <info@captivatechat.com>&#x20;


