Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 6.98 KB

integration-options.md

File metadata and controls

101 lines (62 loc) · 6.98 KB

logo

Customization Options

Before you get started, it's good to know that Surfly can be fully customized to suit your needs. Many of these changes can be achieved by just changing the settings on the admin panel, but they are also available through our API.

This section covers:

Button appearance{#button-appearance}

The Surfly button's default appearance is red, with white text and sits to the bottom left of the screen. You can create your own custom button, or start a session with stealth mode, if you prefer.

Start a session in stealth mode{#stealth-mode}

If you do not wish to have a visual button or link on your webpage, then you can use stealth mode. This allows visitors to initiate a Surfly session simply by pressing CTRL+ENTER. The visitor will then be queue'd, and the Surfly session will start as usual.

Customize your own button{#surflystart-anchor}

If you prefer, you can use the Javascript API to completely customise your own Surfly button. As you can see in the image below, we chose to use the image of a cake as a button. If a visitor to the website clicks on it, it will lead them to a Surfly session.

The end result

The session ID approach{#session-id}

The session ID approach is especially useful if you are already in contact with a customer via the phone. If the customer needs help navigating a website, the agent can direct them to start a co-browsing session. The user can then communicate their ID to the agent so that they will be able to join the session and help them.

Once the agent has the session ID, they can simply enter it into the start session panel on the Surfly admin page, and will immediately join the session.

Start Surfly

Create an invite page{#auto-start}

You can set .startLeader() in the code snippet so that a webpage will automatically start a Surfly session. This option allows you to fully customize your invite page. The page will display the default red Surfly banner, letting the visitor know that they have been queue'd. This red banner may also be removed through a simple change to the code snippet.

Further customization is also possible through the use of the REST API. For example, you can use it to detect whether a Surfly session has started or not, and alter your websites' appearance based on this. For instance, if we're in a Surfly session, we can get the unique queue code which identifies the user who initiated the session and display it.

As can be seen below, we were then able to set up our own invite page:

Queue ID

Integrate with existing chat solutions{#integrate-chat}

It is also possible to integrate Surfly with existing chat solutions. For example, if you have already established your own video or text chat, you may want to add Surfly's co-browsing functionality to this. In this case, Surfly can be integrated in such a way so that it acts as a transparent addition to your product and allows you to entirely customize the appearance of the session.

Simply add the code snippet to the page including your chat solution, and alter it to either remove the user interface entirely, or to display a dock with session control options (more information on the docked_only option can be found here. You will then be able to use Surfly's co-browsing functionality in addition to your own chat solution.

Session continuation{#session-continuation}

Session continuation is used to pass data into, and out of, the Surfly session. For example, if a customer needs help whilst they are filling out a form, the information that they have already entered will be carried over into the Surfly session so that they do not have to repeat what they have already done. This way, if the user was logged in prior to starting a Surfly session, they will remain logged in inside the co-browsing session. Session continuation therefore allows for a smooth transition into, and out of, the session.

Security Features{#security-features}

Surfly's security features allow you the option to protect users' data during the session, and, if required, restrict access to selected webpages.

Field masking{#field-masking}

Field masking allows you to protect data during the Surfly session. If the user is required to enter sensitive information (such as payment details), into your website, you can hide that input from the session followers.

Blacklisting and Whitelisting{#blacklist-whitelist}

Blacklisting is used to ban users from a select few webpages, whereas whitelisting is more restrictive, and allows access only to the pages specified in the code snippet.

{% em color="#ffffe0" %} Please note: This option is only available to enterprise clients. {% endem %}

Add information to the session log{#session-log-info}

You can choose to add a custom message to the Surfly logs in order to register an event. For example, you may want to track the amount of times an individual agent has made a sale.

Customize website appearance depending on who is in control{#customize-appearance-for-user}

Surfly sessions are always comprised of one leader, and one or more followers. The leader is the only person who can click or type during the session, but you can switch control between the leader and the followers. You can specify the features you want to give to the leader and the followers during the session by enabling or disabling icons in the dock. Moreover, you can adapt the status of the elements of a page depending on who is in control. For example, you may want to make a button clickable only when the leader (the person who initiated the session) is in control.