Installing the Web Widget
How to add the CINNOX Widget to your website
Subdomain: refers to the login URL or instance to access your CINNOX service.
You can immediately add the CINNOX widget or use its click-to-action (CTA) features (i.e., Click-to-call or Click-to-chat buttons) on your website.
CINNOX widget - a widget, i.e., a small application interface, located at the bottom of a web page that lets your customers or visitors immediately interact with your business through call or chat.
Click-to-call - a CINNOX widget feature that automatically calls a specific Tag or Staff member whenever a customer or visitor clicks on a web object, i.e., a button, a text, an image or an icon.
Click-to-chat - a CINNOX widget that automatically launches a chat room for a specific Tag or Staff member whenever a customer or visitor clicks on a web object, i.e., a button, a text, an image or an icon.
Here is a step-by-step guide for:
Your website needs to have an SSL certificate for secure HTTPS connection to enable CINNOX's call service.
Installing and Displaying the CINNOX Widget
Log in to the CINNOX Dashboard using your subdomain and login credentials.
From the navigation menu, go to Administration > Widget > Installation to view the installation code. It is enclosed in the code snippet box.
Manually copy the widget code from the snippet box from start to end. Alternatively, click on the Copy button to automatically copy the code snippet
Paste the widget code into the HTML source code of your web page right after the opening tag on every page where you want the CINNOX widget to appear.
Save, publish and reload your web page.
Clicking Test it out! will open a demo page that will show you how exactly the widget and the tags in the Directory will look like on your actual website. This will help you fix any issues before it goes live and is seen by your visitors and customers.
</> Code Snippet Parameters
<body> //Place the CINNOX installation code right after the opening body tag //... Your website's source code ... </body>
Paste the script right after the opening tag.
The CINNOX floating widget should appear at the bottom-right corner of the page.
Adding Click-to-Action (CTA) Buttons
A CTA button is an HTML5 button in your website that you can configure to trigger the following actions in the CINNOX web client without clicking on the widget:
- Open the CINNOX Directory
- Make a call or chat enquiry to a particular tag
Below are live examples of CTA links, buttons, and icons. Try clicking on them to see how it works:
Trigger the Directory
Trigger the Chat function of a Tag
Trigger the Call function of a Tag
To add a CTA button:
- Log in to the CINNOX Dashboard using your domain URL and login credentials.
- From the navigation menu, go to Administration > Widget > Installation to view the installation code.
- Click on the Edit button, then click on + Add New CTA Button.
- Enter a Button ID. This should match the button ID defined in your HTML code.
- Select the Tag and Function the CTA button will be associated with. All created tag(s) will be available in the Tag dropdown list.
- If you select All Tags, then the CTA button will open the widget Directory.
- If you select a particular Tag and Function, then the CTA button will call or chat about that particular tag.
The Button ID is the HTML element's ID that you want to have the trigger effect. Therefore, by setting this ID to your HTML element, you can trigger CINNOX any way you want, i.e., through buttons, images, texts, or even videos.
Make sure that your Tag setting is enabled with the same function as your CTA. Refer to How to Create New Tags section of our User Guide for more details.
- Click on Save.
- Manually copy the widget code from the snippet box from start to end. Alternatively, click on the Copy button to automatically copy the code snippet
- Paste the widget code into the HTML source code of your web page right before the closing tag.
- Apply the CTA trigger by putting the exact Button ID to the element you want to trigger:
<button id='elementID'>Talk to Us</button> // A button <text id='elementID'>Find an Expert</text> // A Text <image id='elementID'>Find an Expert</image> // An Image <span id='elementID' class='fa-happy-face' ></span> // An icon
- Save and reload your web page.
- The CINNOX floating widget should appear at the bottom-right corner of the page.
- The elements (buttons) should be functional with a call or chat function when clicked.
CINNOX allows you to change the attributes of the installed web widget, e.g. its position and visibility on your web page, using the CINNOX widget API framework.
How to change the attributes
After installing the Web Widget and completing the Widget initialisation, you can call window.onCinnoxReady function to change the Web Widget's attributes.
|cinnox.widget.setWidgetPosition(value)||To set the position of the installed widget displayed on the current page.||String|
|cinnox.widget.setWidgetDisplay(value)||To set the visibility of the installed widget displayed on the current page.||Boolean|
The complete example of the installation code below shows how to set your widget to the bottom left or force the page to hide the installed web widget on the current page:
After the function"cinnox.widget.setWidgetPosition('bottom-left')" is called, the web widget is installed at the bottom left of the page.
CINNOX widget API framework provides flexibility to the position of the Web Widget on the web page, avoiding blocking visibility of the important content on the web page, especially when the screen's smaller size is detected on various devices.
Hiding or Disabling the Web Widget
When CTA buttons work better on your web page, you can hide the latter without affecting the HTML CTA button.
To hide the CINNOX widget:
- From the navigation menu, go to Administration > Widget > Appearance , then click on the Edit button at the bottom of the page.
- Toggle the Widget Display button OFF.
- Click on Save.
Any changes in the widget appearance will take effect on the widget where it is installed.
To force remove the CINNOX widget from a web page:
- Delete the code snippet from the web page, then save and reload the page.
Note that this action will also affect any HTML CTA buttons enabled on the page.
For more information on how to configure your CINNOX widget appearance, refer to the Customising Your Widget's Appearance section of this Guide.
Updated 7 months ago