Options

Reference for the configurable options available on the Glassix agent widget

This document outlines the available options for configuring and styling the Glassix agent widget and serves as a reference for developers integrating or maintaining the widget across our products.

Overview

Options let you customize how the agent widget behaves and looks. You add them to the widgetOptions object in your installation script, before you paste it onto your site. For a step-by-step walkthrough of how this fits into the installation process, see the Installation guide.

var widgetOptions = {
    departments: ["departments ids you want to sign into"],
    userName: "your-user-name",
    snippetId: "your-snippet-id",
    // Add any of the options below here
    width: "900px",
    position: "right"
};

Options

These options control which agent signs in, which departments they're signed into, the server the widget connects to, and the widget's size and position on the page.

NameTypeDescriptionDefault
departmentsArray[string]List of department IDs to log into.[]
snippetIdstring
userNamestringThe specific agent's email.
baseUristringGlassix dedicated server URL.https://app.glassix.com
widthstringValid CSS value.900px
heightstringValid CSS value.550px
positionstringleft, rightright
📘

userName is hardcoded in the default install script. To sign in different agents dynamically, override this value with JavaScript before the widget initializes. See Customizing the Username in the Installation guide.