The scripts implemented on your website call the service to check if an onsite message should be shown. For an onsite message to be shown, the site, script tag and targeting criteria chosen must all be fulfilled. This article introduces you to the site settings.
You will find the site settings in Config Hub, under the onsite messaging menu. From this view you are also able to View and copy your API and Soft ID keys which will be needed to connect your sites.
Whether you have just one website in one language or multiple websites in many languages, the site settings need to be implemented and up to date for the onsite services to work.
There are multiple scenarios to address when it comes to websites, like localization, markets, domains, and URL patterns, and most (if not all) of them can be solved using the site settings.
The most basic scenario is a website with only one top domain, one market and one language, such as “ourbrand.com” in the UK, in English.
Other common scenarios are multiple markets and languages handled by:
- Different top domains, for example, “ourbrand.co.uk”, “ourbrand.de”, “ourbrand.fr”.
- The same top domain, but with language/markets URL parameters, like “ourbrand.com/uk/”, “ourbrand.com/de/”, “ourbrand/fr/”, and so on.
Less common, and slightly more complicated, are scenarios with multiple markets in the same top domain, without any URL parameters showing which market/language the visitor is on. It’s important to remember that pinpointing the correct site settings is not only about showing users campaigns in the appropriate language. Factors like currency, integrity legislation/consents, and such may also be different between countries or markets that share the same language.
There are four panels grouping different settings which will be covered in this article:
- General
- Online message settings
- Voyado Engage
- Contact Integrations
General
Site name
Enter the name of the site that will be displayed inside the service. This must be a unique value (two sites cannot have the same site name). Common naming strategies are using the top domain or markets, such as “ourbrand.com” or “Ourbrand UK”, which will help you easily keep track of which onsite messages are displayed on which sites.
Display name
Enter the name of the brand/site name to be displayed to end users. This does not have to be unique—on the contrary, it’s quite common that you'll want your brand to be called the same thing in different markets.
Contact support email
Enter the email address to your customer support to be displayed for end users.
Site URL
Your onsite messages will be displayed by matching your site domain. This field can also use domain and trailing path to narrow where deals will display (such as "ourbrand.com/somepath"). It’s also possible to use multiple domains separated by comma ("ourbrand.com/somepath,otherdomain.com").
Additional URL string to match
TIP
This setting is rarely used and only exists to solve uncommon website configurations.
This setting will add an additional check after the initial domain name matching. If, for example, a website has a language parameter in the URL that is separated from the domain name with values that can be different on different parts of the website, this field can be used to solve that challenge.
Example:
The website "ourbrand.com" has a language parameter at the end of the URL, but other content in between:
https://ourbrand.com/category/product-name/sku-number/se/
You should put "ourbrand.com" in the Domain name field and "/se/" in the Domain additional URL part match field when creating a site targeting Swedish users of the "/se/" site.
Engage tenant ID
Your tenant ID in Voyado Engage is easy to find, as it’s the same as the unique part in your URL when you log in to your Engage environment, for example https://tenant-ID.voyado.com/
Include site URL in shortened links
Whenever a shortened link to one of your onsite messages is created by the service, it looks something like this:
https://l.onsite.voyado.com/6672c478108b
This setting can be used to add the domain name to shortened links, which may give better recognizability for your customers:
https://l.onsite.voyado.com/ourbrand-com/6672c478108b
Ecom platform
Disregard this field, as it’s a legacy field that currently has no use.
Brand logo
Your brand logotype for inserting in the footer of emails sent by the onsite platform. Uploading a brand logo is optional. When using an automation to deliver sendouts through Engage it won't be used at all.
Background image for previews
The onsite message editor has a feature for previewing campaigns while you’re setting them up (before they are published/live on your website). If you want to create a more realistic preview environment, you can upload a screenshot of your website here to act as a backdrop for the preview.
Restrict to country using IP geolocalization
TIP
This setting is rarely used and only exists to solve uncommon website configurations.
Use IP geolocalization to ensure that only visitors from certain countries will be shown deals when visiting the site domain. By creating different sites in the Onsite Manager with the same domain, it’s possible to show users visiting the same website/domain different deals, depending on the country associated with their IP address. Multiple countries can be selected. If no country is selected, deals will be displayed in all countries except for ones that other sites have claimed on the same domain using this feature.
Restrict to locale or language code
TIP
This setting is rarely used and only exists to solve uncommon website configurations.
This setting restricts the site matching to match the locale. To use this setting with locale, the locale variable must be populated and inserted correctly in the script call from the website. (Please refer to the script implementation documentation for more information.) If the locale variable is not present in the script call, it will default to the language code given by the website visitors browser.
Customer support URL
If you prefer to have customers contacting your support by a form on your website instead of emailing, you can add the URL to your customer support page here to replace the email link wherever the customer support email is normally displayed.
Customer support CTA-button link text
The text entered here will be the link text for the customer support link URL whenever it is displayed.
Default attribution time (days)
Enter a numerical value (number of days) within which period a purchase placed on the website should be attributed as a conversion in the reporting. If this value is set to 30 days, for example, any order made by a website visitor within 30 days of completing an onsite message flow will be attributed as a conversion to that onsite message in the reports.
Default friend attribution time (days)
Same as above, but only applies to friends visiting the website through referral links sent to them by another user/visitor.
Time zone
Choose the appropriate time zone using UTC (Coordinated Universal Time) for handling scheduling times of onsite messages, validity time for offers, countdown timers and so on.
Unsubscription URL
Here you can enter a URL for users who wish to unsubscribe from marketing communication or manage their consents in other ways.
Onsite message settings
This part of the Onsite Messaging site settings groups those settings that affect the look, feel and behavior of your onsite campaigns on a site-wide level. Many of these settings can then be overridden by onsite message-specific settings as desired.
Lightbox background color
When an onsite message is viewed in its maximized version, a lightbox effect overlays the website to make it “fade into the background”. This lightbox effect can be either white or black and then combined with the opacity setting to adjust the effect.
Lightbox background opacity
The lightbox background can be adjusted from 0-100%, where 100% will obscure your website completely in the background and 0% will make the lightbox effect completely invisible.
Close onsite message on DOM change
TIP
This is a rarely used setting, and this is often better handled by adjusting the script implementation if and when necessary.
When used on single page applications, a loaded campaign may remain indefinitely (depending on how the scripts are implemented) even if the user navigates to a different page on the website (since there are no page load events on an SPA). Enable this option to remove the minimized bar after a short delay when the user starts interacting with the website by listening to DOM events.
Disable triggering other onsite messages through script when visitor comes to website using a "Onsite message URL" link
When this setting is enabled, onsite messages that would normally be triggered will not show for users who come to the website using a "Onsite message URL" link.
Language
Here you set the default language for the site, which is used to decide which default texts to use when creating new onsite messages.
Z-index when minimized
Z-index is used to decide which elements on a website go “on top” of other elements. For example, an object with a z-index of 2 will be displayed above an object with a z-index of 1. This setting decides the z-index of a minimized campaign.
Z-index when maximized
This setting decides the z-index of maximized campaigns and the default value is 1000.
You would normally always want a pop-up or maximized campaign to be displayed on top of all other content on the website, so depending on how your website is configured, this value might have to be increased to get the desired behavior.
Default opt-in text
This field is for creating a standard opt-in “Yes” text that is used as a template when creating new onsite messages. It’s a good way to ensure that you don’t have to write the same consent texts over and over when creating new campaigns for your website.
Default opt-in not approved text
Same as the above, but “no” instead of “yes”.
Default friend opt-in text
If you want to display other consent texts to friends visiting your website through referral links, this can be achieved here.
Default friend opt-in not approved text
Same as the above, but “no” instead of “yes”.
Default additional terms text
Campaigns can include optional and mandatory consents as well as other terms. This field enables setting a default terms text to be used as a template for new campaigns. For example, "By using our website, you accept the General Terms and Conditions".
Default friend additional terms text
This field does the same as the above but enables setting a different terms text as a template for friends.
Disable onsite tracking until consent has been given in an onsite message
TIP
Using this setting will impact the quality of the service and it is recommended to ensure compliance with all rules and regulations by collecting the appropriate consents in conjunction with the overall consent handling on the website instead.
Using this setting means that no tracking information at all will be saved in the user’s browser until the user has interacted with an onsite message and given consent directly in that onsite message.
Automatically delete personal data when processing is completed
This setting enables automatic deletion of personal data (such as email addresses) after there are no more scheduled reminders left to serve. Voyado recommends having this setting enabled as default.
Connecting to Voyado Engage
The onsite messages on your website need to be connected to Engage via API in order for the real time connection between the onsite messages on your website and the contact database in Voyado Engage to work.
API Key
Enter the API key from Voyado Engage Config Hub in this field.
Engage Domain
This is the domain of your Voyado Engage environment, i.e. https://ourbrand.voyado.com. If you’re setting up a site for a staging environment, it may look like this: https://ourbrand.staging.voyado.com.
For some tenants that have been clients of Voyado for a long time, it may also look like this: https://ourbrand.eclub.se and/or https://ourbrand.staging.eclub.se.
Store external ID
This field should be mapped to the appropriate Store external ID used for the website in Engage. This will be the default Store external ID set if nothing else is set on an onsite message level. The message level setting for Store external ID is very useful when setting up onsite messages for physical stores, which is covered in more detail in the articles about setting up onsite messages.
Country code
Decide which country code will be set by default on contacts entered from this site.
Use automation for email and/or text message sendouts
With this setting enabled, you can set up automations for sending emails and/or SMS messages to your contacts through Engage instead of the onsite platform's default email service. This is highly recommended as it’s a better end user experience, makes all communication trackable in Engage, and so on. There’s more information on send-outs in articles about setting up onsite messages, but in short, any onsite message has the ability to trigger confirmation and reminder sendouts to the user.
Interaction name
Custom interactions can be automatically registered on contacts entered into Engage using this setting.
Interaction ID
This setting is related to the setting above.
Soft ID
Enter the Soft ID key from Voyado Engage config hub to enable the onsite messaging scripts to indentify onsite visitors that reach the website through newsletter clicks.
Get consents
Pressing this button will load all available consents that are set up in Voyado Engage and make them available in the dropdown menu.
Choose consents
Using this dropdown menu, you can choose which consents in Voyado Engage should be automatically applied to all contacts/members that are entered into the database via Onsite Messaging.
Add a custom text field that should be applied to all contacts
With this feature you can add an unlimited number of custom fields and values that should be automatically added to the contact cards of any contacts registered on the site in question.
Contact integrations
There are “out of the box” connectors available for integrating Onsite Messaging to platforms such as Hubspot, Centra, Adobe Commerce/Magento 2, Shopware, and BigCommerce.
The connectors are straightforward to set up and you can most commonly find documentation on the respective e-com platforms’ websites describing how to generate/find the credentials, such as API keys and access tokens, needed.
Connecting the Onsite platform to communicate with the database in Voyado Engage and your e-com platform in real time enables several functionalities, including member signups onsite or in a physical store using QR codes. It also creates a user account on the website and triggers a verification email. The email allows the user to verify their email address and choose a password.
Another example of a feature utilizing the real-time connection is Reach Ability. This real-time consent management feature checks whether a contact is reachable as soon as they are identified on the website, such as by logging in. If they are not reachable, it triggers a well-timed question asking them to update their consents.
Article last reviewed
Comments
0 comments
Please sign in to leave a comment.