Site settings define the technical configuration for each website where you want to display onsite messages. They connect Voyado Engage to your website and control how messages are tracked, targeted, and displayed. Each website you use for onsite messaging needs its own site configuration. In most cases, sites are set up during onboarding — but if you are adding a new market or website, you may need to create or copy an existing site. Only the site name and site URL are required to get a site working; all other settings are optional and used only in specific scenarios.
Where to find site settings
Site settings are found in Engage Config Hub, accessible from the top-left navigation in Engage. Go to Engage Config Hub > Onsite messaging > Sites. Here you will see a list of all configured sites for your environment, including each site's status, number of active onsite messages, and URL.
From the Sites list, you can also access two quick-action buttons at the top of the page:
- View and copy API keys — shows the API keys for all sites, useful when setting up a new integration.
- View and copy Soft ID — shows the Soft ID keys used for contact identification.
To open a site's settings, click its name in the list. To add a new site, click + Add site.
Required settings
Two fields must be completed for a site to work:
- Site name — a name to identify this site within Engage (for example, the market or brand name).
- Site URL — the URL of the website where messages will be shown.
Once these are in place, the site is functional. All other settings are optional and only need to be configured in specific circumstances.
Optional settings
Optional settings are grouped under accordions in the site settings panel. They are collapsed by default to reduce visual complexity — expand them only if your setup requires it.
URL, locale and region
These settings control which visitors a site applies to, based on their URL, region, and language. They are used when your website does not use standard URL patterns to identify a visitor's country or language.
- Additional URL string to match — restricts messages to visitors on pages that contain a specific URL string.
- Restrict to country — limits message display to visitors from a specific country.
- Time zone — sets the time zone used for scheduling.
- Restrict to locale or language code — limits messages to visitors whose browser locale matches a specific code (for example, en-GB or GB).
- Restrict to match CSS class — restricts messages to pages where a specific CSS class is present.
- Match to CSS class value — used together with the CSS class restriction above to match a specific value.
- Include site URL in shortened links — controls whether the site URL is included when shortening links in messages.
Note: Avoid filling in these fields unless you have a specific reason to. Enabling options such as country or locale restrictions when they are not needed can cause messages to display incorrectly or not at all.
Customer support
An optional section for providing contact details shown to visitors who need support. This is not required for messages to function.
What a correct setup looks like
A correctly configured site has:
- A site name entered.
- A valid site URL entered.
- The Voyado Engage tracking script installed on the website (this is handled by your development team during onboarding).
- Optional settings configured only where your specific website setup requires them.
If you are unsure whether optional settings are needed, check with your IT team or the person who handled your onboarding.
Adding a new site
If you are adding a new market or website, the easiest approach is to copy an existing site that is already correctly configured. This carries over all settings, so you only need to update the site name, URL, and any fields specific to the new site.
To create a site from scratch, click + Add site in the Sites list and fill in at minimum the site name and site URL.
What typically goes wrong
- Filling in optional fields that should be left blank — the most common issue. For example, setting a country restriction when not needed will prevent visitors from other countries from seeing your messages.
- Incorrect site URL format — make sure the URL matches exactly how it appears in the browser.
- Tracking script not installed on the website — onsite messages cannot appear if the Voyado tracking script is not present on the page. This is a development task and must be completed before any campaigns can go live.