Skip to main content
You may want to implement the use of a vanity domain for your embedded dashboards if you need to utilize first-party cookies or would like to have cohesive branding of the content you share with your clients.

​
Requirements

This feature is only available for private embed use cases. Additionally, the domain you select has a set of requirements:
  • Only one vanity domain is allowed per Omni organization.
  • Have a multi-part domain like products.ecommerce.com or dev.products.ecommerce.com.
  • You must use a new, dedicated subdomain:
    • Omni needs to configure specific DNS records and SSL certificates for the domain.
    • The domain must be set up to proxy requests to Omni’s infrastructure.
    • Existing endpoints serve different content and can’t be repurposed for Omni embeds.

​
Selecting a domain

When selecting a domain, keep the following in mind:
  • A vanity domain must have three, or more, parts. For example, ecommerce.com without products prepended will not be considered a valid vanity domain.
  • The top-level domain of the vanity domain must match the embedding page to support first party cookies.
    • If your embedding page is ecommerce.com, then your embedded vanity domain should be omni.ecommerce.com
    • If your embedding page is ecommerce.com and you provide an embedded vanity domain of ecommerce.omni.com then you may still run into third-party cookie limitations on some browsers like Safari or other iOS applications.

​
SDK example

Typescript SDK
Vanity domain of analytics.blobsrus.com
const iframeUrl = await embedSsoDashboard({
  contentId: "miU0hL6z",
  externalId: "blobby@blobsrus.com",
  name: "Blobby",
  host: "analytics.blobsrus.com",
  secret: "abcdefghijklmnopqrstuvwxyz123456"
})

​
Setup

  1. Reach out to Omni support with the vanity domain you want to use, e.g. products.ecommerce.com.
  2. Omni will reach back out with DNS configuration details and ask that you update your DNS configuration.
  3. Notify Omni that the update is complete.
  4. Omni will notify when the setup is complete.