A site connects onsite messaging to one of your websites, so that you can show onsite messages there. Each website, or each market on a website, has its own site with its own settings, and an onsite message only shows on pages that match its site. This article describes every site setting in the Onsite Manager, what it does, and when you need it.
Find your sites
Sign in to the Onsite Manager at manager.onsite.voyado.com and go to Configuration > Sites. The list under All Sites shows each site's name, domain, and number of active onsite messages, and whether the site is Online or Offline. Use Search to find a site.
Select a site's name to open its settings, or select Add site to create a new one.
Plan your sites
Before you add or change a site, think about how your website separates markets and languages. You need one site for every combination of market and language that should get its own onsite messages.
| Your website | How to set up your sites |
|---|---|
| One domain, one market, and one language, such as ourbrand.com in English | One site, with the domain as the Site URL. |
| A different domain for each market, such as ourbrand.co.uk, ourbrand.de, and ourbrand.fr | One site for each domain, each with its own Site URL. |
| One domain with the market or language in the path, such as ourbrand.com/uk/ and ourbrand.com/de/ | One site for each path, with the path included in the Site URL, for example ourbrand.com/uk/. |
| One domain where the market or language appears later in the URL, such as ourbrand.com/category/product/se/ | One site for each market, with the domain as the Site URL and the market part, such as /se/, in Additional URL string to match. |
| One domain with no market or language in the URL at all | One site for each market, separated with Restrict to country or Restrict to locale or language code. This is the least common setup and depends on how your website calls the onsite messaging script. |
Markets that share a language can still need separate sites. Currency, consents, and legal requirements often differ between countries, even when the text is the same.
How the site settings are organized
A site's settings are split into cards. Select Edit on a card to open it and Done to close it. When you've made your changes, select Save settings at the bottom of the page, or Cancel to leave without saving.
| Card | What it contains |
|---|---|
| General | The site's name and URL, the checks that decide which visitors the site applies to, branding, customer support, and attribution. |
| Onsite message settings | Defaults for all onsite messages on the site: the lightbox, language, layering, opt-in and terms texts, behavior, and privacy. |
| Voyado Engage | The connection to Customer Engagement, plus stores, interactions, consents, contacts, and Product Discovery customer keys. |
| Contact integrations | Connections to other platforms, such as your e-commerce platform or CRM. |
| Feature settings | Settings for testing the onsite messaging script during development. |
General
Site name and URL
Site name (required)
The name of the site in the Onsite Manager. It must be unique, so two sites can't have the same name. Visitors don't see it. Name your sites after their domain or market, such as ourbrand.co.uk or Ourbrand UK, so it's easy to see which onsite messages run where.
Site URL (required)
The address of the website where onsite messages are shown. Your messages show on pages whose address matches this value. It can be a domain, such as ourbrand.com, or a domain with a path, such as ourbrand.com/uk/, to show messages only in part of the website. To use more than one domain, separate them with a comma, for example ourbrand.com/uk/,ourbrand.co.uk.
Engage tenant ID
Your tenant in Customer Engagement. It's the same as the unique part of the address you use to sign in, for example ourbrand in https://ourbrand.voyado.com/.
Time zone
The time zone used for times you set in onsite messages, such as start and end dates and reward validity. Choose the time zone of the market the site is for.
URL, locale, and region
These settings add extra checks after the Site URL has matched, to decide which visitors the site applies to. You only need them if your website doesn't separate markets or languages through the Site URL alone.
Filling in these settings when you don't need them is the most common reason onsite messages don't show. For example, a country restriction stops visitors from all other countries from seeing your messages.
Additional URL string to match
A part of the URL that must also match, after the domain. Use it when the market or language is in the URL, but not right after the domain.
For example, if your Swedish pages look like https://ourbrand.com/category/product-name/sku-number/se/, enter ourbrand.com as the Site URL and /se/ here.
Restrict to country
Shows the site's onsite messages only to visitors from the countries you choose. The country comes from the visitor's IP address, or from a country variable if your website sends one in the script call. You can choose more than one country.
This lets you create several sites on the same domain and show different messages depending on the visitor's country. If you don't choose any country, the site's messages are shown in all countries, except those that other sites on the same domain have restricted to themselves.
This setting is rarely needed. It only exists to solve uncommon website setups, where one domain serves several countries without the country in the URL.
Restrict to locale or language code
Shows the site's onsite messages only to visitors with a specific locale or language code, such as en-GB or GB. The locale comes from the locale variable in the script call on your website. If the script call doesn't include a locale, the language of the visitor's browser is used instead.
Restrict to match CSS class
Shows the site's onsite messages only on pages that contain a specific CSS class. This is a rarely used setting for websites where the market or language can only be read from the page itself.
Branding
Brand name
The name visitors see, for example as the sender of emails. Unlike the Site name, it doesn't need to be unique, so you can use the same brand name for all your markets.
Brand logo
Your logo, shown in emails sent from onsite messaging. Select Replace, Clear, or Crop to change it.
Background image for previews
An image shown behind your onsite message when you preview it. Upload a screenshot of your website to make the preview look more like the real thing.
Customer support and attribution
Default attribution time (days)
The number of days during which a purchase on your website is attributed to an onsite message in your reports. For example, if you set 30 days, any order a visitor places within 30 days of completing a message counts as a conversion for that message.
A single message can override this with Specific attribution time (days) in its general settings.
Default friend attribution time (days)
The same as Default attribution time (days), but for friends who visit your website through a referral link from a refer-a-friend campaign.
Customer support email
The email address of your customer support, shown to visitors who need help.
Unsubscription URL
The page visitors are sent to after they unsubscribe and their personal data has been deleted in a contact integration. Use it to send visitors to your own or a third-party unsubscribe page. The URL can include the variable @email to pass on the visitor's email address.
Customer support URL and Customer support CTA-button link text
A page on your website for customer support, such as a contact form, and the text of the link to it, for example Contact us.
Onsite message settings
These settings affect all onsite messages on the site. Many of them are used as defaults when you create a message, and you can change them in each message.
Lightbox and layering
Lightbox background color (required)
When an onsite message is maximized, a lightbox covers the website behind it so that the message stands out. This sets the lightbox color.
Lightbox background opacity
How see-through the lightbox is, from 0% (invisible) to 100% (the website is completely hidden). We recommend 75%.
Z-index when minimized and Z-index when maximized
The z-index decides which elements on a page are shown on top of others. An element with a z-index of two is shown above an element with a z-index of one. The default for both is 1000.
Adjust the minimized value if a minimized message ends up behind, or in front of, other elements on your website, such as menus or chat widgets. A maximized message and its lightbox should normally be shown on top of everything else, so you might need to raise the maximized value if parts of your website still show on top of it.
Language and default texts
Language
The default language of the site. It decides which default texts, button labels, and other elements new onsite messages get. You can change the language in each message.
Default opt-in text and Default opt-in not approved text
The default texts for the visitor's choice to accept, or not accept, your privacy policy. They're used as a starting point in new onsite messages, so you don't need to write the same texts every time.
Once a visitor has accepted the privacy policy, it isn't shown to them again on the same site. The not approved text is only shown if opt-in isn't required.
Default friend opt-in text and Default friend opt-in not approved text
The same as above, but for friends who visit your website through a referral link.
Default additional terms text and Default friend additional terms text
The default terms text for new onsite messages, for visitors and for friends. Once a visitor has accepted the terms, they aren't shown again.
Behavior and privacy
Close onsite message on DOM change
For single-page applications. On these websites, a minimized message can stay on screen after the visitor moves to another page, because the page never reloads. Turn this on to close the message when the page changes, for example on a virtual page view. Off by default.
Disable triggering other onsite messages through script when visitor comes to website using a "Onsite message URL" link
When a visitor comes to your website through a link to a specific onsite message, other messages that would normally be triggered aren't shown. This keeps the visitor focused on the message they came for. Off by default.
Disable onsite tracking until consent has been given in an onsite message
Stops onsite messaging from saving any tracking data in the visitor's browser until the visitor has given consent in an onsite message. Off by default.
This setting lowers the quality of the service. We recommend that you collect the consents you need through your website's overall consent handling instead.
Automatically delete personal data when processing is completed
Deletes personal data, such as email addresses, once there are no more scheduled reminders left to send. Off by default, but we recommend that you turn it on.
Include site URL in shortened links
Adds your domain to the shortened links created for your onsite messages, such as referral links, which makes them easier for visitors to recognize. On by default.
For example, https://l.onsite.voyado.com/6672c478108b becomes https://l.onsite.voyado.com/ourbrand-com/6672c478108b.
Voyado Engage
This card connects the site to Customer Engagement, so that onsite messages can create and update contacts in real time.
Connection
API Key
The API key from Customer Engagement that the site uses to connect.
Engage Domain
The domain of your Customer Engagement environment, such as ourbrand.voyado.com. For a staging environment, it looks like ourbrand.staging.voyado.com, and for some long-time customers it ends in eclub.se.
Store external Id
The store in Customer Engagement that contacts from this site are connected to. A single onsite message can set its own store, which is useful for messages shown in physical stores.
Country code
The country code given to new contacts from this site.
Use automation for email and/or text message sendouts
Sends confirmation and reminder emails and text messages through automations in Customer Engagement, instead of through onsite messaging's own email service. We recommend this, since it makes all communication trackable in Customer Engagement.
Marketing group language
The language of the marketing group in Customer Engagement that the site belongs to. Choose the same language as the marketing group configured in Customer Engagement. This setting is optional, and is mainly used by clients who use Ratings & Reviews.
Interactions and identification
Interaction name and Interaction ID
Registers a custom interaction in Customer Engagement on the contacts that come in through the site, so that you can track and use them, for example in automations.
Soft ID
The Soft ID key from Customer Engagement. It lets onsite messaging recognize visitors who come to your website by clicking a link in a newsletter.
Consents and contacts
Get Consents and the consent list
Select Get Consents to load the consents set up in Customer Engagement. Then choose the consents that should be applied to every contact who comes in through onsite messaging on this site.
Default contact type
Whether new contacts from this site are created as a Member or a Contact. Check your setup in Customer Engagement to see which one to use. A single onsite message can set its own contact type.
Populate custom field
Adds custom fields and values to the contact card of every contact who comes in through this site. Select the plus icon to add one.
Product Discovery customer key
Only needed if you also use Product Discovery. These settings tell onsite messaging where to find the customer key that Product Discovery uses to identify a visitor, so that the visitor gets personalized content.
- Cookie Key for Elevate Customer Key: the name of the cookie that holds the customer key.
- LocalStorage key for Elevate Customer Key: the name of the local storage key that holds the customer key.
- Jwt token enable: turn on if your website identifies customers with a JWT (JSON Web Token).
Contact integrations
Contact integrations connect onsite messaging to Customer Engagement and other platforms, such as your e-commerce platform or CRM, in real time. This makes several features possible, for example:
- Member signups online or in a physical store: visitors sign up on your website, or in a store by scanning a QR code. The integration can also create a customer account on your website and send a verification email, where the visitor verifies their email address and chooses a password.
- Reach Ability: when a contact is identified on your website, for example when they log in, onsite messaging checks whether they can be reached. If they can't, it shows a well-timed message that asks them to update their consents.
- Select Edit on Contact integrations.
- In Select Integration, choose the platform. Ready-made integrations are available for platforms such as Centra, Adobe Commerce, Magento, Shopware, BigCommerce, Shopify, and Salesforce. Choose Generic to connect a platform through your own API.
- Fill in the integration's credentials, such as API keys or secrets. You'll usually find out how to create them in your platform's own documentation.
- Select Done, and then Save settings.
Feature settings
Allow local development (send site Id in voyado configuration)
Lets your developers test onsite messages on a local development environment, such as localhost, by skipping the check that the page matches the Site URL. The site's ID must then be passed in the voyado('config') call of the script. Off by default. Turn it off again when testing is done.
Add a site
- In Configuration > Sites, select Add site.
- Fill in the Site name and Site URL on the General card.
- Fill in the Onsite message settings and the connection on the Voyado Engage card.
- Add any other settings your website setup needs, and select Save settings.
If a similar site is already set up correctly, check its settings and use the same values for the new site where they apply.
Onsite messages can only show on a website that has the onsite messaging script installed. Your development team usually adds it during onboarding.
If onsite messages don't show
If an onsite message is live but doesn't show on your website, check the site first:
- Does the page address match the Site URL, and the Additional URL string to match if you use it?
- Are any of the country, locale, or CSS class restrictions filled in when they don't need to be?
- Is the message on the right site? You can see the site on the message's General card.
- Are the z-index values high enough for the message to show on top of your website?
To learn how the site, script tag, and targeting work together, see How a message is selected.