Overview

This documentation details the process of setting a custom visitor ID (visitorId) in the TrueEngage widget. This feature allows users to provide information about the visitor they recognize (e.g., upon login).

Feature Description

Visitor information can be added to a widget by passing it in a JavaScript object before embedding the widget on a web page. Passing a custom visitor ID allows you to maintain a consistent interaction history and chat resumes from different devices.

Implementation Steps:

Define Custom Channel Settings

• Initialize a global settings object for the widget if it does not already exist:

  window._cceSettings = window._cceSettings || {};
  

• Add your visitor ID to the property visitorId in the _cceSettings object.

Examples

window._cceSettings = {
      visitorId: 'custom_visitor_id_4'
    };

Best Practices

• Make sure you pass the id correctly, if you pass an id belonging to another user they may have access to a chat history that is not theirs.
• Test the action functions thoroughly to confirm they work as expected.
• Remember that the ID must be passed before initialization, if you set a custom ID for a visitor who has already been on the site for a while you may lose some history(visitorJourney)

For further assistance or advanced customization options, please contact support.