How to create an on-site widget

Introduction to creating a new widget

This guide will provide you with a simple step-by-step guide to creating a new on-site widget in the console (email widget will be treated in 

Scenario

We want to create a new widget to display product recommendations on our basket page. 

Step-by-step guide

Step 1

Open your Early Birds console and click on Merchandising>Widgets

Step 2

Click on Add a widget

Step 3

Choose 'on-site' as the type of widget you would like to create.

Step 4

Record the basic information for your widget:

• Name: as it will appear in the widget's list
• Tags: internal use only, to allow you to quickly filter widgets within your list
• Description (optional)
• Displayed title: title that will be visible to your clients on your site, e.g: Our top recommendations for you
• Template: This is the visual aspect of the widget, which has been created and defined in advanced settings in the console beforehand
• Location: This is the place where the widget is inserted in the page of the site where it is triggered. The placement of the widget can also be defined beforehand
  • If using API to display the widget, leave this field blank
  • If you have a javascript integration, make sure to create the location and its path beforehand in the dedicated section within the console (developers>locations)

Step 5

Global AB test:

By default, your new widget will be shown to all your visitors. The Early Birds console natively integrates the ability to AB test the display of your widget to just some of your visitors.

To define the share of the population exposed to the widget, drag the cursor to the expected value:

In this example, we define the share of population exposed to the widget as being 66%.

Step 6

Set the display conditions:

By default, a widget will be displayed in all cases on the page of the site where it is triggered. One can define possible display conditions according to the user or navigation context.

Click on the "+" symbol to setup new display conditions. You can add as many levels as you like but the more conditions you add, the less the widget is likely to appear as it will need to satisfy all conditions in order to show.

Refer to the Variables heading for more information.

Step 7

Enter the minimum items needed to display recommendations of minimum results:

A minimum number of results can be defined if you wish. This number must often consider the template used by the widget. 

If, in certain cases, the algorithm sends fewer products than the number planned in the template, there will then be a blank space in the widget. In this case, one can package the display of the widget only if a minimum number of results is achieved.

You can either use the arrows on the right to define this or directly enter a number:

Step 8

Your widget is now ready to be displayed to your visitors.

Click on Create to save the widget edition.

Next Steps

Your feedback is important to us, please take a moment to let us know if you found this article helpful by clicking "Yes" or "No" in the "Was this article helpful?" section below or by adding a comment.