Connect White Label

Entri Connect Growth tier and above. Included on Entri Sell

The whiteLabel object lets you customize the Entri Connect modal to match your branding. Everything below is configured under the whiteLabel key of the config passed to entri.connectDomain(config). All properties are optional. Boolean flags default to false, and any property left unset falls back to Entri’s default. You may need an Enterprise level account for some properties to be available; contact your account manager with questions. Entri Unify runs on this same modal, so these properties also theme the Unify flow, including its selection screen. See Unify configuration for the Unify-specific details.

This page documents the redesigned Connect modal, which is the default UI for every application, and lists only the whiteLabel keys it supports. The previous modal is deprecated. If your integration still passes keys from it, the legacy keys page lists the ones the redesigned modal still honors and how to migrate off them.

`whiteLabel` object

boolean

When true, hides all mentions of “Powered by Entri”, including the footer branding and the Entri globe in the domain icon.

boolean

Hides your logo in the domain icon on the initial screen, the multi-domain selector, and the Unify selection screen.

boolean

Hides the company name across the flow.

string

An https URL. When set, it overrides the configured Application logo and uses this one instead. We recommend an SVG or PNG that is 1:1. Invalid URLs are rejected with a console error and the logo is left blank.

string

Sets a background color for the logo mask. Useful if your logo is white with a transparent background.

boolean

When true, removes the rounded mask/border applied over your logo.

When true, removes the sharing link functionality across the whole application.

boolean

Skips the congratulations screen shown after a successful domain configuration. customProperties.congratulations.disableScreen has the same effect.

object

Colors, fonts, and dimensions. See theme below.

object

Per-screen behavior toggles. See customProperties below.

object

Text and copy overrides per locale. See customCopy below.

To white-label the sharing link URL itself, replacing app.goentri.com with your own branded domain, configure the Sharing link URL field in your Dashboard under Account Settings, Application Settings. This is an Enterprise-tier feature and requires no code changes. See Sharing Link Custom Domain for details.

`whiteLabel.theme` Object

Customizes the colors, fonts, and dimensions of the modal to match your app’s branding.

string

Primary brand color (hex code). Applies to primary buttons and links. Non-hex values are rejected with a console error and the default is used. Recommended for quick theming.

string

Text color on primary elements (hex code). Applies to text on buttons. Non-hex values are rejected with a console error and the default is used. Recommended for quick theming.

string

Color scheme: "disabled" (light), "enabled" (dark), or "auto" (matches the system preference). Defaults to disabled.

string

The modal’s width. In embedded mode it also sets the width of the embedded iframe, unless general.embeddedMode.fillContainer is true. Ignored on shared-link views.

Background color of the modal container.

string

Links color, to override HTML’s default blue.

string

Backdrop/overlay color. Use a transparent hsla or rgba value.

string

The border CSS styling for buttons, e.g. solid 1px #000.

string

The border-radius CSS styling for buttons, e.g. 5% or 10px.

string

The border-radius CSS styling for input fields, e.g. 8px.

string

camelCase alias of inputs.border.radius.

string

Overrides the modal font-family with a Google Font. The font must exist in the Google Fonts catalog; otherwise a console error is logged and the default font is kept.

string

The weight to load for the Google Font, e.g. 400. Must be a weight the font supports.

string

The bold text weight for the Google Font, e.g. 600.

`whiteLabel.customProperties` Object

Enterprise tier.

Changes behaviors related to specific elements or a screen’s behavior.

string

A valid CSS selector (e.g. #entri-container) for the target element where the Entri Connect UI should be embedded. If null, the flow opens in a modal. If the element is not found, the launch is aborted with a console error. The embedded iframe defaults to 600 by 600 pixels with the modal’s rounded corners and shadow; use theme.width to change the width and containerStyles to change the corners and shadow.

boolean

When true, makes the embedded widget fill its parent container at 100% width and height, and removes the default border-radius and box-shadow. Requires general.embeddedMode.selector to be set.

object

Styles applied to the embedded iframe. Only borderRadius and boxShadow are honored, in camelCase, e.g. { "borderRadius": "8px" }.

boolean

When true, hides the close (X) button in the header. Useful when your own UI is responsible for dismissing the widget.

boolean

When true, Entri’s default “Are you sure you want to leave?” exit confirmation dialog is suppressed and the onEntriRequestClose event fires instead when the user clicks the close (X) button. Your app must then run its own confirmation UI and call entri.close() to dismiss the widget.

boolean

Disables the Existing Records override prompt and confirms automatically.

boolean

Prevents the manual screen from being shown. Adds manualScreenDisabled: true to the onEntriClose event.

boolean

Skips the congratulations screen after the domain connection. Equivalent to the top-level skipCongratulationsScreen.

Displays the terms of service on the Provider Login screen. Also accepted as a top-level whiteLabel.showEntriToS.

Hides the “Change provider” option in the “Other ways to connect” dialog.

Hides the “Set up manually” option in the “Other ways to connect” dialog on the Provider Login screen.

Disables the extended login animation and leaves only the default one in place.

Keeps the forward-to-a-colleague option visible, but clicking it no longer opens Entri’s forward screen. Entri emits the onEntriSharingLinkClick window event instead so your app can handle the share.

Hides the Forward Link entirely, so the forward-to-a-colleague link does not render on the Provider Login or manual setup screens.

object or string

Background of the shared-link flow page. Use a CSS background string, or an object with camelCase background sub-properties, e.g. { "backgroundColor": "red" }.

boolean

Disables the default Entri background decorations on the shared-link flow.

`whiteLabel.customCopy` Object

Entri Connect Premium tier and above. Included on Entri Sell

Customizes texts along the flow to match your brand’s tone or when the default copy doesn’t fit your use case. Translations are keyed by locale; the en locale is required and all missing translations fall back to English.

string

Sets the title of the domain analysis screen for the specific locale.

string

Sets the subtitle shown under the domain analysis title for the specific locale.

Sets the Provider Login introduction’s translation text for the specific locale. Accepts the {PROVIDER} replacement token. Supports  for bold.

string

Sets the description of the two-factor authentication screen for all 2FA methods.

string

Sets the description of the two-factor authentication screen for SMS codes.

string

Sets the description of the two-factor authentication screen for email codes.

string

Sets the description of the two-factor authentication screen for authenticator apps.

string

Sets the title of the manual configuration screen for the specific locale.

boolean

Disables opening the documentation URL set in the manualSetupDocumentation configuration property. Commonly combined with the onEntriManualSetupDocumentationClick event to trigger a custom JS function.

string

Sets the step-by-step-guide translation text for the specific locale. Supports <link></link> tags for triggering JS functions (useful for chatbots): enclose the call-to-action text in <link></link> and catch the onEntriManualSetupDocumentationClick event.

string

Sets the Congratulations title’s translation text for the specific locale. Accepts the {DOMAIN} replacement token. Supports  for bold.

string

Sets the Congratulations description’s translation text for the specific locale. Accepts the {USER} and {DOMAIN} placeholders. Supports  for bold.

string

Sets the Congratulations button call-to-action’s translation text for the specific locale. Supports  for bold.

string

The value that replaces the {USER} token in congratulations.description.

string

Sets the Congratulations title for the Entri Sell flow. Accepts the {DOMAIN} and {APPLICATION_NAME} replacement tokens. Supports  for bold.

string

Sets the Congratulations description for the Entri Sell flow. Accepts the {USER} and {APPLICATION_NAME} replacement tokens. Supports  for bold.

string

The value that replaces the {USER} token in congratulations.sell.description.

string

Sets the title of the error screen for a specific error code, e.g. errorScreen.GenericError.title.en.

string

Sets the details text of the error screen for a specific error code, e.g. errorScreen.TimeoutError.details.en.

Locales are codes such as en, es, fr, etc. If no matching translation is found for the locale in use, Entri’s default text is used. See the full list of supported locales in the configuration reference.

White label code example

{
  "whiteLabel": {
    "hideEntriLogo": true,
    "skipCongratulationsScreen": true,
    "theme": {
      "fg": "#FFFFFF",
      "bg": "#1F77F8",
      "darkMode": "auto"
    },
    "customProperties": {
      "providerLogin": {
        "changeProvider": { "hide": true }
      }
    },
    "customCopy": {
      "congratulations": {
        "title": { "en": "You're all set, {DOMAIN}!" }
      }
    }
  }
}

Get Started

Activate Suite

Domain Management

SSL Provisioning

For DNS Providers

DNS Concepts

Entri MCP

Reference

Legal & Security

Resources

Connect White Label

`whiteLabel` object

`whiteLabel.theme` Object

`whiteLabel.customProperties` Object

`whiteLabel.customCopy` Object

White label code example

​whiteLabel object

​whiteLabel.theme Object

​whiteLabel.customProperties Object

​whiteLabel.customCopy Object

​White label code example

`whiteLabel` object

`whiteLabel.theme` Object

`whiteLabel.customProperties` Object

`whiteLabel.customCopy` Object

White label code example