General Settings

General Settings

General settings for configuring the chat widget:

PropertyDefaultDescription
delayBetweenBotMessages1000The synthetic delay added by the widget if the DG bot sends multiple messages in a row.
messageAnimationDuration300The duration of the animation on messages entering the widget.
enableInactiveTabNotificationstrueEnables a notification in the page title about new messages when the page is not focused.
hasDragAndDropAttachmenttrueEnables drag-and-drop functionality for file uploads.
hasSendButtontrueWhether the send message button is enabled.
headerIcon''The icon displayed in the pre chat form and widget header. Can be an image url or base 64 encoded image.
isAnimationDisabledfalseDisables widget mount/unmount animations.
isChatCloseControlEnabledtrueWhether the dialog close control is enabled or not.
isChatMinimizeControlEnabledtrueWhether the dialog minimize/expand controls are enabled or not.
isDialogMaximisedfalseWhether the widget should be maximized on page load.
isChatLauncherEnabledtrueWhether the chat launcher is enabled. If set to false, the widget must be manually launched.
launcherVariant''Which pre defined launcher to use. star, smile or chatBubbles.
maskCreditCardNumberstrueRedacts any credit card or IBAN numbers entered into the widget before they are displayed or transmitted to any server.
showDownloadAttachmentsButtontrueWhether to show the download button for attachments.
enableCrmUserAttachmentstrueEnables the user to upload attachments after handing over to an agent. Only applies to Sunco and Gorgias.
enableNavigationTrackingtrueAdds a system event to the conversation page when the user navigates to a new page. May not work for some single-page apps. Use the trackNavigation method.
enableDGPoweredByLinktrueWhether the 'Powered by DigitalGenius' link is displayed and linked to the DG website.
persistSessiontruePersists the session between page reloads or multiple tabs. Disabling this is useful for WISMO widgets.
isEmbeddedModefalseWhen true, the widget is maximized by default, and when the user closes the chat, the conversation ends, but the widget remains open with the pre-chat form.
isWidgetDisabledfalseWhen true, the widget will not be displayed.
maxUserMessageLength250The maximum number of characters a user can send in a message.
csatCloseButtonDisabledfalseWhether the csat close button is disabled or not.
enableUnreadNotificationtrueWhether to enable the unread notification on the launcher when messages are received whilst chat is minimised.
enableBackToBottomButtontrueWhether to display the back to bottom button when the user scrolls up in the conversation.
closeChatAfterAgentInitiatedCsatfalseWhen true, after a helpdesk agent has ended the chat the widget will close after the user has provided csat
externalLaunchElementnullLaunch the widget from an external element on the webpage. Must be a valid css selector accepted by document.querySelector
endExpiredSessionOnTabFocusfalseWhen true, the widget will check if the session has expired when the tab gains focus. If the session has expired, the widget is closed and the session ends.
sendMessageOnEnterKeytrueWhen true, messages are sent when the user presses the Enter key. Otherwise the Enter key will add a new line (recommended for Japanese users).
openLinksInNewTabtrueWhen true, any links within chat will open in a new tab, rather than the same window.

What’s Next