Web Widget

This feature enables you to seamlessly integrate your Copilot into your existing website, providing easy access for visitors.

Add your Copilot to your site easily.

General

• Audio Transcription - Enables converting voice inputs into text directly within the widget.

• AI Web Call - Allows users to make calls directly from the web widget. Activating this feature consumes platform credits.

• Copilot Position - Adjust the Copilot's position on your website as needed. |

  Enable voice-to-text, calls, and adjust your Copilot's position easily.

• Draggable - Enables users to drag and reposition the Copilot widget on the screen.

• Mobile Device Visibility - Ensures the widget is accessible and functional for users on mobile devices.

  Enable voice-to-text, calls, and adjust your Copilot's position easily.

• Logged In Users Only - When the Logged In Users Only toggle is enabled, the widget will only be visible to users who have signed in. This ensures that only authenticated users can access the widget.

  Enable Logged In User toggle

  • Set User - To activate this feature, use the setUser event to provide user details for authentication. If the details are not passed, the user will not be able to interact with the Copilot chatbot.

    window?.copilot?.("event", "setUser", {
    hostId: "12312", // Mandatory
    email: "[email protected]",
    name: "Smith",
    additionalFields: {
        orgId: 123,
    },
    });
    
    // Either `email` or `name` (or both) must be provided along with `hostId` for user identification.

    Field	DataType	Description
    hostId	String	Unique identifier assigned to each user (mandatory).
    email	String	User’s email address. Optional but useful for identification and communication.
    name	String	User’s full name. Used to personalize interactions.
    phone	Integer	User’s phone number. Optional but useful for contact purposes.
    profilePicUrl	String	URL to the user’s profile picture. Optional but enhances user profiles visually.
    additionalFields	Object	Additional details like age, gender, or interests for improved chatbot responses.

  • Unset User - When a user logs out, use the unsetUser event to clear their session from the widget.

    window?.copilot?.("event", "unsetUser");

• Resume Conversation - When enabled, the Copilot resumes the last conversation with the user. If disabled, it starts a new conversation each time the page is opened.

• Allowed Domains and Paths - Define specific domains and paths where the widget is allowed to function. This helps maintain security and ensures the widget is only accessible from approved locations.

Embed Code

To add the Copilot to your website, copy and paste the following code into your webpage:

Copy and paste this code to add the Copilot to your website