HelloSettings

Type.

Allows configuration of Zonos Hello. These settings can be overridden by the `zonos.init` function in the Zonos Elements SDK.

Fields

allowedDomains

•

[String!]!

Required

A list of domains to allow Hello to send frontend requests from. Hello will not function for domains not listed here.

anchorElementSelector

•

String!

Required

CSS selector for a DOM element for Hello to visually anchor to

cartUrlPattern

•

String

Regex pattern matching the URL of your site's cart page

countryDisplayRules

•

HelloCountryDisplayRules!

Required

Country-based display rules for the Hello widget (which countries see the widget, and which appear in the country selector)

countryOverrideBehavior

•

HelloCountryOverrideBehavior!

Required

How the buyer's country override is propagated across page loads

createdAt

•

DateTime!

Required

When the HelloSettings was created

createdBy

•

ID!

Required

The user who created the HelloSettings

currencyBehavior

•

HelloCurrencyBehavior!

Required

How Hello should handle currency conversion

currencyElementSelector

•

String!

Required

CSS selector for your site's currency/money fields

desktopLocation

•

HelloDesktopLocation!

Required

Where Hello should display on desktop

dutyTaxEstimationBehavior

•

HelloEstimateBehavior!

Required

How Hello should handle on-the-fly duty/tax estimation

excludedUrlPatterns

•

[String!]!

Required

Optional list of URL patterns to not display Hello on. Regex matching supported

homepageUrlPattern

•

String

Regex pattern matching the URL of your site's homepage

•

ID!

Required

A unique identifier for the HelloSettings

mobileLocation

•

HelloMobileLocation!

Required

Where Hello should display on mobile

mode

•

Mode!

Required

Whether this HelloSettings is in live or test mode

organization

•

ID!

Required

The organization this HelloSettings belongs to

peekMessageBehavior

•

HelloPeekMessageBehavior!

Required

Whether or not Hello should display peek messages in its collapsed view

peekMessageDelay

•

Decimal!

Required

If peek messages are enabled, how many seconds before they should appear after page load

productAddToCartElementSelector

•

String

Which element is used for the product add to cart buttons. Used to power the item restrictions feature

productDescriptionElementSelector

•

String

Which element is used for the product descriptions. Used to power the item restrictions feature

productDetailUrlPattern

•

String

Regex pattern matching the URL of your site's product detail page

productListUrlPattern

•

String

Regex pattern matching the URL of your site's product list/category list pages

productPriceElementSelector

•

String

Which element is used for the product prices. Used to power the item restrictions feature

productTitleElementSelector

•

String

Which element is used for the product name. Used to power the item restrictions feature

restrictionBehavior

•

HelloRestrictionBehavior!

Required

How Hello should handle item restrictions

status

•

HelloStatus

Deprecated. see visibilityStatus.

subscriptionStatus

•

HelloSubscriptionStatus!

Required

Determines billing status for Hello

updatedAt

•

DateTime!

Required

When the HelloSettings was most recently updated

updatedBy

•

ID!

Required

The user who most recently updated the HelloSettings

visibilityStatus

•

HelloVisibilityStatus!

Required

The current status of the HelloSettings

widgetSize

•

Decimal

The size of the Hello widget in pixels

Fields

Was this page helpful?