Integrating Agents

    Once your agent is deployed, the Integrate tab on the agent details page becomes active. This is where you connect the agent to the channels your users will actually interact through, whether that's a chat widget on your website, an internal bot in Zoho Cliq, a WhatsApp Business channel, or a direct API call from your own application.

    Before deployment, the Integrate tab remains empty. You need to deploy the agent (via connection or as a digital employee) before any of these options become available.

    The Integrate tab is organized into three sections: Chat Interface, Messaging & Social Channels, and Developer Interface.

    Chat Interface

    ChatKit

    ChatKit lets you embed a fully customizable chat UI on your website or product. When a visitor or user opens the widget, they're talking directly to your deployed agent.

    Setting up ChatKit

    1. Open the Integrate tab on your deployed agent's details page.
    2. Select ChatKit from the left panel.
    3. Choose the access mode:
      • Public: Anyone visiting the page where the widget is embedded can interact with the agent.
      • Private: Only authenticated or authorized users can chat with the agent. Switching from Public to Private will prompt you to confirm the SDK visibility change.
    4. If access is set to Private, create a chat key:
      • Click Chat Key.
      • Enter a name for the key.
      • Click Create.
    5. Copy the two code snippets from the Initialization Script section:
      • The first is a script tag that loads the ChatKit SDK.
      • The second is a custom HTML component that configures the widget with your org ID, agent entity ID, welcome message, and auto-open behavior.
    6. Paste both snippets into your website's HTML where you want the chat widget to appear.

    The Conversation panel on the right side lets you preview how the widget will look and behave before you embed it.

    Managing ChatKit

    Click the three-dot menu next to the Initialization Script heading for additional options:

    • Edit Version: Update the agent version the widget uses.
    • Disable ChatKit: Turn off the integration entirely.

    Cliq Chatbot

    Cliq Chatbot lets you use your agent inside Zoho Cliq to assist teams with internal conversations. Team members can message the bot directly within their everyday communication tool.

    Setting up a Cliq Chatbot

    1. Open the Integrate tab on your deployed agent's details page.
    2. Select Cliq Chatbot from the left panel.
    3. Click Create Bot.
    4. Provide the following:
      • Name: The display name for the bot as it will appear in Zoho Cliq.
      • Description: A short summary of what the bot does.
      • Access Level: Choose between Personal (only you can interact with the bot) or Organization (everyone in your org can access it).
    5. Click Create Bot.

    The bot becomes available in Zoho Cliq and responds using the deployed agent's configuration, tools, and knowledge base.

    Note: Cliq integration needs to be enabled for your account. If you don't see the option, check with your admin.

    Messaging & Social Channels

    This section lets you connect your agent to messaging platforms so customers can interact with it through the channels they already use.

    WhatsApp

    WhatsApp integration lets customers chat with your agent through an official WhatsApp Business number. Setting this up involves a one-time configuration in Settings, followed by connecting the channel to your agent.

    Step 1: Enable Instant Messaging

    1. Navigate to Settings > Instant Messaging.
    2. Enable the integration.

    Step 2: Link your Meta Business account

    1. Click Link Account.
    2. You'll be redirected to Meta's login page.
    3. Authorize Zia Agents to connect with your WhatsApp Business account through Facebook Business Manager.
    4. Complete the authorization flow and return to Zia Agents.

    Step 3: Create a channel

    1. After linking your account, click Create Channel.
    2. Follow the prompts to configure your WhatsApp messaging channel.

    Step 4: Connect the agent to WhatsApp

    1. Open the Integrate tab on your deployed agent's details page.
    2. Select WhatsApp from the left panel.
    3. Click Set up WhatsApp.
    4. Select the channel you created and connect it.

    Notes:

    • A WhatsApp Business account is required.
    • The Instant Messaging setup in Settings (steps 1 through 3) is a one-time configuration. Once done, the WhatsApp option becomes available across all your deployed agents.

    Developer Interface

    Agent API

    The Agent API lets you trigger your agent programmatically from custom functions, external applications, or automated workflows. The Integrate tab displays:

    • OAuth Scope
    • Authentication method
    • HTTP Method
    • Endpoint URL
    • Request headers
    • Request body format

    For the full setup including authentication, request parameters, sample code, and a working Deluge example, see API Overview & Authentication and Agent API Reference.

    PREVIOUS

    UP NEXT