A site connects Voyado Customer Engagement 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 a message only shows on a page that matches its site. Getting these settings right decides whether your messages show up at all, in the right language, and for the right visitors. This article describes every site setting, what it does, and when you need it.
Find your sites
Go to Administration > Config Hub > Onsite messaging > Sites. The list shows each site's name, status, number of active onsite messages, and URL. Use the search field to find a site, or Sort by to change the order.
At the top of the list, you'll also find:
- View and copy API keys: shows the API keys for your sites, which you need when you connect a site to your website.
- View and copy Soft ID: shows the Soft ID keys used to identify visitors who come to your website from a newsletter.
- Add site: creates a new site.
Select a site's name to open its settings.
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 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 four sections. Select Edit on a section to change it, and Save when you're done, or Cancel to leave it as it was. A green check shows that a section is configured.
| Section | What it contains |
|---|---|
| General | The site name and URL, plus optional settings for URL, locale and region, customer support, attribution, and privacy. |
| Onsite message settings | Defaults for all messages on the site: layering, branding, language and opt-in texts, and message behavior. |
| Voyado Customer Engagement | The connection to Voyado Customer Engagement, plus optional settings for interaction tracking, stores, contacts, and Elevate. |
| Contact integrations | Connections to other platforms, such as your e-commerce platform or CRM. |
Only the Site name, Site URL, the two Z-index settings, Language, Engage Domain, and API Key are required. Everything marked as optional can be left empty unless your website setup needs it.
General
Site name and URL
Site name
The name of the site inside Voyado Engage. 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 messages run where.
Site URL
The address of the website where 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.
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 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 Site URL. 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 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.
Time zone
The time zone used for times you set in messages, such as start and end dates, reward validity, and countdowns. Choose the time zone of the market the site is for.
Restrict to locale or language code
Shows the site's 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 and Match to CSS class value
Shows the site's messages only on pages that contain a specific CSS class, set in Restrict to match CSS class. Use Match to CSS class value to set the value that class must have. This is a rarely used setting for websites where the market or language can only be read from the page itself.
Include site URL in shortened links
Adds your domain to the shortened links created for your messages, such as referral links, which makes them easier for visitors to recognize.
For example, https://l.onsite.voyado.com/6672c478108b becomes https://l.onsite.voyado.com/ourbrand-com/6672c478108b.
Customer support
Contact details shown to visitors who need help, for example in messages and sendouts.
Customer support email
The email address of your customer support, shown to visitors.
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
A page on your website for customer support, such as a contact form. If you fill this in, visitors are sent to this page instead of being shown the support email address.
Customer support CTA-button link text
The link text shown for the Customer support URL, for example Contact us.
Attribution strategy
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.
Privacy and consent
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 (cookies, local storage, or session storage) until the visitor has given consent in an onsite message.
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. We recommend that you turn this on.
Onsite message settings
These settings affect the look, feel, and behavior of 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.
Display order and layering
The z-index decides which elements on a page are shown on top of others. An element with a z-index of 2 is shown above an element with a z-index of 1.
Z-index when minimized
The z-index of minimized messages. Adjust it if a minimized message ends up behind, or in front of, other elements on your website, such as menus or chat widgets.
Z-index when maximized
The z-index of maximized messages, such as popups. A maximized message and its lightbox should normally be shown on top of everything else on the page, so you might need to raise this value if parts of your website still show on top of it.
Branding and visual appearance
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 the footer of emails sent from onsite messaging. It isn't used if you send emails through an automation in Voyado Engage.
Background image for previews
An image shown behind your message when you preview it in the editor. Upload a screenshot of your website to make the preview look more like the real thing.
Lightbox background color
When a 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.
Language & tone rules
Language
The default language of the site. It decides which default texts, button labels, and other elements new 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 messages, so you don't need to write the same consent 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. Use them if friends should see different consent texts.
Default additional terms text and Default friend additional terms text
The default terms text for new messages, for visitors and for friends. For example, By using our website, you accept the General Terms and Conditions. Once a visitor has accepted the terms, they aren't shown again.
Message behavior
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.
This is often better solved in how the script is implemented on your website.
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 message's Onsite message URL, other messages that would normally be triggered aren't shown. This keeps the visitor focused on the message they came for.
Voyado Customer Engagement
This section connects the site to Voyado Customer Engagement, so that onsite messages can create and update contacts in real time.
Engage Domain
The domain of your Voyado 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. The domain is shown here but can't be changed.
API Key
The API key from Voyado Engage that the site uses to connect.
Interaction tracking
Interaction name and Interaction ID
Registers a custom interaction in Voyado Engage 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 Voyado Engage. It lets onsite messaging recognize visitors who come to your website by clicking a link in a newsletter. You'll find it with View and copy Soft ID in the list of sites.
Store and location
Store external Id
The store in Voyado Engage that contacts from this site are connected to. It's used unless a message sets its own store, which is useful for messages shown in physical stores.
Country code
The country code given to new contacts from this site.
Contact and consent
Default contact type
Decides whether new contacts from this site are created as contacts or members, and with which contact type. The list shows the contact types set up in your Voyado Engage. Check your setup in Voyado Engage to see which one to use.
Use automation for email and/or text message sendouts
Sends confirmation and reminder emails and text messages through automations in Voyado Engage, instead of through onsite messaging's own email service. We recommend this, since it gives visitors a better experience and makes all communication trackable in Voyado Engage.
Populate custom field
Adds custom fields and values to the contact card of every contact who comes in through this site. You can add as many as you need.
Elevate customer identification
Only needed if you also use Voyado Elevate. These settings tell onsite messaging where to find the customer key that Elevate uses to identify a visitor, so that the visitor gets personalized content.
- LocalStorage key for Elevate Customer Key: the name of the local storage key that holds the customer key.
- Cookie Key for Elevate Customer Key: the name of the cookie that holds the customer key.
- Jwt token enable: turn on if your website identifies customers with a JWT (JSON Web Token), and enter the Jwt token identify key.
Contact integrations
Contact integrations connect onsite messaging to other platforms in real time, such as your e-commerce platform or CRM. This makes features possible like signing up members online or in a physical store with a QR code, and creating a customer account on your website with a verification email.
- Select Edit on Contact integrations.
- In Select Integration, choose the platform. Ready-made integrations are available for platforms such as HubSpot, Centra, Adobe Commerce, Magento, Shopware, BigCommerce, Shopify, and Salesforce.
- Select the plus icon to add the integration, and fill in its credentials, such as API keys or access tokens. You'll usually find out how to create them in your platform's own documentation.
- Select Check Connection to test the integration, and then Save.
For platforms without a ready-made integration, a generic integration lets you connect through your own API. You set the API Authentication Method (Header, HMAC, or API Key), the API Authentication Key, the endpoints for looking up and creating or updating contacts, and which keys hold the email, phone number, name, and personal identity number.
Add a site
- In the list of sites, select Add site.
- Fill in the Site name and Site URL.
- Fill in the required settings in Onsite message settings and Voyado Engage.
- Add any optional settings your website setup needs, and select Save.
If a similar site is already set up correctly, check its settings and use the same values for the new site where they apply.
Messages can only show on a website that has the Voyado onsite messaging script installed. Your development team usually adds it during onboarding.
If messages don't show
If a 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 URL, locale and region restrictions filled in when they don't need to be?
- Is the message on the right site? You can see the site in the message's general settings.
- Is Z-index when minimized or Z-index when maximized high enough for the message to show on top of your website?
To learn how the site, script tag, and display conditions work together, see How a message is selected.