Integration

Embed Script

To integrate the Widget into your site, start by placing the embed script on every relevant page. This script initializes the widget and ensures seamless call transitions during co-browsing sessions.

<script async src="https://asset.fwcdn3.com/js/live-helper.js" data-fwparam_chat_channel_id="[ChatChannelId]"></script>

Note: Please update the above snippet where it has [ChatChannelId] to the business's chat channel ID. The chat channel ID can be found on the business portal URL. Example: https://business.fireworktv.com/business/5EROOo/channel/Q01bn6Y Q01bn6Y will be the chat channel ID

The Visitor Widget is an easy way to provide one-to-one service to visitors. It appears automatically and guides visitors towards sales help.

To display the widget, ensure that both the embed script and the live helper web component are present on pages where you want the Visitor Widget to be visible.

<fw-live-helper style="z-index:9007199254740991; position:fixed"></fw-live-helper>

The fw-agent-status web component is a powerful tool designed to display the availability status of sales agents in your web application. This component utilizes slots to seamlessly integrate with your existing HTML structure, providing flexibility and ease of use. To display the widget, ensure that you have embed script present on your page.

Properties

`action` (String, optional, default: startCall)

Specifies the action to be performed when the user interacts with the component. Possible values are:

"startCall": Initiates a call when the user interacts with the component.
"startChat": Initiates a chat when the user interacts with the component.
"showWidget": Displays a widget when the user interacts with the component.

Slots

The fw-agent-status component supports the following slots:

available: Content to be displayed when the sales agent is available.
not-available: Content to be displayed when the sales agent is not available.
loading: Content to be displayed while the component is loading or determining the agent's availability.

Example:

<fw-agent-status>
  <div slot="available">
    Sales Agent is Available
  </div>
  <div slot="not-available">
    Sales Agent is Not Available
  </div>
  <div slot="loading">
    Loading...
  </div>
</fw-agent-status>

Styling

Feel free to customize the component's appearance by applying your styles. The component uses shadow DOM to encapsulate its styles, ensuring that your styles won't affect other elements on the page.

Note: Before the fw-agent-status component is defined, it will render all slots. This can be mitigated by applying CSS to hide the slots until the component is defined. The following example shows how to show only the Loading slot before the widget is initialized.

Example CSS:

fw-agent-status:not(:defined) [slot="available"], fw-agent-status:not(:defined) [slot="not-available"] {
  display: none;
}

The External API provides a set of methods to control and interact with a Live Helper in your page. This API allows you to dynamically show, initiate a chat, or start a call. If you need access to the external API, make sure to include embed script on your page.

API

_fwn.liveHelper.actions.showWidget()

Displays the web component.

_fwn.liveHelper.actions.startCall()

Initiates a call with sales associate within the Live Helper.

_fwn.liveHelper.actions.startChat()

Initiates a chat with sales associate within the Live Helper.

Initialization

Ensure that the _fwn object is present in the window scope before using any of the API methods. If the object is not available, you need to wait for fw:ready event, before you can continue.

Example

<script>
    function showWidget() {
        window._fwn.liveHelper.actions.showWidget()
    }
    if (window._fwn && window._fwn.liveHelper) {
        // _fwn is available, use the API immediately
        showWidget()
    } else {
        // Wait for fw:ready event
        document.addEventListener('fw:ready', ()=>{
            showWidget()
        });
    }
</script>

The behavior of the Live Helper Widget can be controlled by including the fw_oto_action parameter in the URL. If you need to control widget with URL, make sure to include embed script on your page. The possible values for parameter fw_oto_action are:

show: Show the widget.
call: Start a call using the widget.
chat: Start a chat using the widget.

Example Usage:

To show the widget:

https://fw.tv/live-helper-no-widget.html?fw_oto_action=show

To start a call:

https://fw.tv/live-helper.html?fw_oto_action=call

To start a chat:

https://fw.tv/live-helper.html?fw_oto_action=chat

Conversion Tracking

To track One-to-One influenced GMV, please check the Conversion Tracking doc to implement the tracking.

Customization

Our widget can take optional embedding parameters to configure the widget for your requirements. You can provide the parameters as data attributes on the embed script.

When choosing the embed script approach, the settings will affect other FW widgets on the same site. It may be more desirable for settings such as localization.

// Embed script parameters. Note that it needs `data-fwparam_` prefix.
<script async src="https://asset.fwcdn3.com/js/live-helper.js" data-fwparam_lang="ja" data-fwparam_chat_channel_id="[ChatChannelId]"></script>

Localization

The Firework visitor widget supports numerous languages. By default, it leverages the browser's language settings. You can utilize the lang attribute to align it with your website's preferred language.

<script async src="https://asset.fwcdn3.com/js/live-helper.js" data-fwparam_lang="ja"></script>

Co-browsing

The Firework visitor widget offers advanced co-browsing capabilities, enabling SA to gain deeper insights into visitors. Based on local privacy regulations, these features might require user consent before activation. Utilize the monitoring_permission option to manage these co-browsing functionalities.

MONITORING_PERMISSION_ALLOWED turns on both live preview and browsing history.
MONITORING_PERMISSION_DENIED switches off co-browsing capabilities.

For changes to the default co-browsing settings on your chat channel, please contact technical support.

<script async src="https://asset.fwcdn3.com/js/live-helper.js" 
  data-fwparam_monitoring_permission="MONITORING_PERMISSION_ALLOWED"></script>

Positioning

We offer various customization options for seamless integration with your website's design.

Distance from the bottom edge

Modify the --fw-live-helper-bottom CSS variable to change the vertical position.

body {
    --fw-live-helper-bottom: 100px;
}

Use the live_helper_placement parameter to define whether the widget should be placed in the bottom right (BOTTOM_RIGHT) or left (BOTTOM_LEFT)corner. The default value is BOTTOM_RIGHT.

<script async src="https://asset.fwcdn3.com/js/live-helper.js" 
  data-fwparam_live_helper_placement="BOTTOM_LEFT"></script>

PreviousOverview NextConfiguration

Last updated 3 months ago

Firework 1-1

Integration

Embed Script

Properties

`action` (String, optional, default: startCall)

Slots

Styling

API

_fwn.liveHelper.actions.showWidget()

_fwn.liveHelper.actions.startCall()

_fwn.liveHelper.actions.startChat()

Initialization

Example

Example Usage:

Conversion Tracking

Customization

Localization

Co-browsing

Positioning

Distance from the bottom edge

Widget placement

Embed Script

Properties

action (String, optional, default: startCall)

Slots

Styling

API

_fwn.liveHelper.actions.showWidget()

_fwn.liveHelper.actions.startCall()

_fwn.liveHelper.actions.startChat()

Initialization

Example

Example Usage:

Conversion Tracking

Customization

Localization

Co-browsing

Positioning

Distance from the bottom edge

Widget placement

`action` (String, optional, default: startCall)