Configuration

Description

WebChat and WebChatService share the configuration namespace '_genesys.cxwidget.webchat'. WebChat has UI options while WebChatService has connection options.

Example

window._genesys.cxwidget.webchat = {

	apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
	dataURL: 'https://api.genesyscloud.com/gms-chat/2/chat',
	userData: {},
	emojis: true,
	actionsMenu: true,

	autoInvite: {

		enabled: false,
		timeToInviteSeconds: 10,
		inviteTimeoutSeconds: 30
	},

	chatButton: {

		enabled: true,
		template: '<div>CHAT NOW</div>',
		effect: 'fade',
		openDelay: 1000,
		effectDuration: 300,
		hideDuringInvite: true
	}
};

Options

Name	Type	Description	Default	Required
apikey	string	Apigee Proxy secure token	n/a	Yes, if using Apigee Proxy
endpoint	string	Manually select the endpoint to initiate the chat	n/a	n/a
dataURL	URL String	URL of GMS server	n/a	Always
userData	object	Arbitrary JSON attached data to include when initiating a chat	{}	n/a
ajaxTimeout	number	Number of milliseconds to wait before AJAX timeout	3000	n/a