Captivate Chat
  • 📚Overview
  • 💻Components
  • 📕Changelog
  • 🚀Get Started
  • DASHBOARD
    • Homepage
      • Setup
        • My AI Chatbots
        • Chat Flows
      • Transcripts
      • Tokens
      • Settings
        • Edit Profile
        • Manage Plan
        • Account Details
        • Referrals
  • START CREATING
    • Create an AI Chatbot
      • Setting Up
      • Import Your Own Information
        • URL Crawler
      • Select Type
      • Train your AI Chatbot
      • Select Integration
      • Finishing Touches
      • Modify your AI Chatbots
    • Create a Chat Flow
      • Setting Up
      • AI Chatbots
      • Select Channel
        • Channel: Web Chat
          • Preview your Web Widget
        • Channel: Facebook
        • Channel: Instagram
        • Channel: WhatsApp
          • Setting up WhatsApp
          • Submit your first WhatsApp Sender
          • Setting up more WhatsApp Senders
          • Configure the Endpoint for Integration
        • Channel: Full Chat
          • Preview Full Chat Channel
        • Channel: Custom Channel
          • JavaScript Socket API
          • Socket API
          • Socket Conversation Testing
      • Select Live Chat Vendor
      • Modify your Chat Flow
    • Connect a Live Chat
      • Microsoft Teams
        • Set up the Captivate Chat MS Teams App
          • MS Teams App Chat Prompts
        • Connect your Captivate Chat account
        • Connect your Chat Flow
        • MS Teams App Chats
        • Test your Microsoft Teams integration
    • Create a Custom Component
  • 💬SUPPORT
Powered by GitBook
On this page
  • Configure Custom Channel
  • API Key
  • Test your Custom Channel!

Was this helpful?

  1. START CREATING
  2. Create a Chat Flow
  3. Select Channel

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.

PreviousPreview Full Chat ChannelNextJavaScript Socket API

Last updated 3 months ago

Was this helpful?

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

  • If you are not using JavaScript, we advise you read through our full socket documentation

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.

REQUIREMENTS

Before proceeding with the rest of the Custom Channel integration process, make sure you have the following:

  • An active developer environment: Our Custom Channel is not an independent tool. Rather, it has to be plugged into an existing developer environment.

REMINDER

The Custom Channel is a development-heavy tool. It needs more active testing compared to our other Channel types.

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.


Configure Custom Channel

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

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.

You may proceed with the following:

Access to our WebSocket tools: Get our WebSocket package in .

this link
JavaScript Socket API
Socket API
Socket Conversation Testing
here.
The "Step 2: Select Channel" page will have Custom Channel highlighted in blue when you click it.
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.
You will get an API Key after clicking "Create Channel" in the "Configure Custom Channel."
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.
You will get an API Key after clicking "Create Channel" in the "Configure Custom Channel."
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.