Category: Javascript API


Since the SnapEngage code snippet loads asynchronously, there are certain limitations on when you can use, and/or have access to our Javascript API.

Unlike a non-asynchronous include, you cannot be sure that the SnapEngage functions will be available when the …

Full Article →

Overview

At some point, you may need to hook your custom code into JavaScript events, or you may want to instruct Google Analytics to track certain events. In this article you will find all of SnapEngage’s JavaScript Events, and a

Full Article →

Overview

Enable or disable all sounds produced by SnapEngage for visitors.


Full Article →

Overview

Deprecated. We are not supporting this API at present. Instead, please use this setting inside your Admin Dashboard as described here

Should the Chat notify the Agent when the Visitor navigates to a new page?

Full Article →

Overview

Should Proactive Chat invitations be allowed to fire? You can use this to disable (or re-enable) proactive chat wherever it might be necessary.


Full Article →

Overview

Deprecated. We are not supporting the screenshot option at present. We plan to re-introduce a better, more widely compatible version of the feature at a later date.

Should the Pre-Chat and Offline forms include the Screenshot option? (The screenshot

Full Article →

Overview

Clear and delete all cookies set by SnapEngage for the current Visitor.


Full Article →

Overview

Disable the “Lightbox” effect for the Pre-Chat Form. That is: the greyed-out background when the Pre-Chat Form comes up.


Full Article →

Overview

Check whether or not you have agents online and your live chat is available.

Full Article →

Overview

Sometimes it will be helpful to know the ID of the currently-active Widget. Especially if you use .setWidgetId() to change the active widget on the fly.


Full Article →

Overview

Immediately hide the floating “Chat” / “Help” button defined in the Configurator.


Full Article →

Overview

Manually start SnapEngage’s Proactive Chat.

Full Article →

Overview

Send a message to the active Chat Agent without showing it to the Visitor. Optionally, add a second parameter of ‘visitor’ to send this message to the Visitor.

Full Article →

Overview

Set the non-hover button position for your button. (Direction is set automatically by your button’s position.)


Full Article →

Overview

Hook a function onto a SnapEngage JavaScript Event


Full Article →

Overview

Manually set the position where you would like the chat window to appear. (Will not reposition an already-visible chat box.)


Full Article →

Overview

Pre-populate any field on your Pre-Chat or Offline form. (The field is still editable by the Visitor.)

 

For Design Studio users only. Legacy chat users may

Full Article →

Overview

Pre-populate the “Description” field on the Pre-Chat Form. (The description is still editable by the Visitor.)


Full Article →

Overview

Allows you to set SnapEngage to use a different language than the one you have set up in your Configurator.


* IMPORTANT NOTE: In order to use the .setLocale()

Full Article →

Overview

Disable or alter the amount of time that Proactive Invitations remain disabled for any visitor who closes a chat window.


Full Article →

Overview

Adjust the time before the Proactive Invitation disappears.


Full Article →

Overview

Provide a Visitor’s email address to SnapEngage. This will do two things: First, it pre-populates the “email” input field on your “Pre-Chat Form” (if you are using one); Second, even if you are not using a “Pre-Chat” form, SnapEngage

Full Article →

Overview

Provide a Visitor’s name to SnapEngage. This will provide a Visitor’s name to an Agent who takes the chat.

This method must be used in conjunction with the SnapEnage.setUserEmail() Javascript function …

Full Article →

Overview

Manually set the currently-active Widget by its Widget ID. The most common use example would be offering chat buttons which are linked to separate widgets on a single page, for instance, creating one link that goes to your Help

Full Article →

Overview

Immediately show the floating “Chat” / “Help” button defined in the Configurator.


Full Article →

Overview

Start a chat session and send a manually defined message to the Visitor.

Note: In most cases, using .startLink() is preferable. In some very specific use cases, .openProactiveChat() would work

Full Article →

Overview

The default method for starting a chat from an on-page <a> link’s onclick event .

Example: <a href=”#” onclick=”SnapEngage.startLink();”>Chat with me!</a>

Full Article →