ZenotiHelp

Cookie Consent Management Platform (CMP) adapter framework

ZTZenoti Docs Team Updated September 8, 2026 8 min readGuide

The Webstore reads guest consent preferences from the cookie management platform your organization has deployed. When a guest updates their cookie choices in a CMP banner, the Webstore immediately applies those preferences without requiring a page reload. This article explains how the adapter framework works and what your team needs to know to operate it correctly.

Audience: Webstore administrators and compliance teams responsible for managing cookie consent on the guest-facing Webstore.


On this page


Before you begin

  • Your organization must have deployed one of the supported CMPs listed in this article on the same page as the Webstore, or must be using the Zenoti in-house consent banner.
  • Only one CMP adapter is active per page load. If you have multiple CMP scripts present on the page, only the first one detected in the adapter chain will be used.
  • The IAB TCF v2 adapter is present in the framework but is intentionally not active. Do not attempt to register it without explicit compliance approval from your legal and compliance teams. Organizations whose CMP relies exclusively on IAB TCF v2 signals are not currently supported for automatic consent reading.
  • Confirm with your CMP vendor that the vendor-specific cookies, global objects, or event names the Webstore listens for are being set correctly by your CMP configuration.

Important: Changes to CMP configuration on your organization's pages may take up to 30 minutes to propagate through the Webstore cache before they are reflected in guest-facing behavior.

How the adapter chain works

The Webstore evaluates available CMP adapters in a fixed sequence. Each adapter exposes a detect step that inspects the page for the presence of its CMP β€” for example, by checking for a specific cookie name or a known global object. The first adapter whose detection step finds a matching signal is selected; the remaining adapters are not evaluated.

The detection order is:

  1. Zenoti in-house banner β€” always evaluated first
  2. OneTrust
  3. Cookiebot
  4. CookieYes
  5. Osano
  6. Usercentrics

Once an adapter is selected, it handles all consent state reads and subscribes to consent-change events for the lifetime of the page session. No other adapter in the chain is evaluated after a match is found.

Important: If your organization has deployed both the Zenoti in-house consent banner and a third-party CMP on the same page, the Zenoti banner signal always takes precedence. The third-party adapter will not be evaluated.

Supported CMP adapters

The following CMPs are supported. Each adapter detects its CMP and listens for consent-change events using the mechanism described below.

CMP Detection signal Consent-change event
OneTrust OptanonConsent cookie OneTrustGroupsUpdated
Cookiebot Cookiebot.consent global object CookiebotOnAccept and CookiebotOnDecline
CookieYes cookieyes-consent cookie cookieyes_consent_update and cky_consent_update
Osano Osano.cm.getConsent method osano-cm-consent-saved
Usercentrics UC_UI.getServicesBaseInfo method ucEvent

Note: The Zenoti in-house banner adapter is also part of this framework and is evaluated before all third-party adapters. See The Zenoti in-house banner adapter below.

When the Webstore loads, the selected adapter reads the current consent state from the CMP's cookie or global object. If no prior consent has been recorded by the CMP, the Webstore treats all non-necessary categories as not granted until the guest makes an explicit choice in the banner.

Regardless of which CMP your organization uses, the adapter normalizes the vendor-specific consent categories into a common five-category model. This ensures that the Webstore applies consent signals consistently regardless of the underlying CMP.

The five categories are:

Category Description Default when CMP is present
necessary Cookies required for the Webstore to function Always granted β€” cannot be declined by the guest
functional Cookies that enable personalized features Reflects the guest's explicit choice
analytics Cookies used to measure usage and performance Reflects the guest's explicit choice
advertisement Cookies used for advertising and conversion tracking Reflects the guest's explicit choice
performance Cookies related to performance optimization Reflects the guest's explicit choice

The necessary category is always reported as granted. The adapter maps the vendor's own category names to these five categories. Your CMP may use different category labels β€” the Webstore handles this mapping internally.

Note: The exact mapping between your CMP's vendor-specific categories and the five Webstore consent categories depends on the CMP's own category structure. Consult your CMP vendor's documentation to understand how their categories correspond to standard consent purposes.

The Zenoti in-house banner adapter

The Zenoti in-house banner adapter is always evaluated first in the adapter chain. When the Zenoti banner is active and eligible on the page, its consent signal takes precedence over any external CMP signal detected on the same page.

This means:

  • If your organization uses the Zenoti consent banner, guest choices recorded in that banner are the source of consent state for the Webstore session.
  • Any third-party CMP also present on the page will not be evaluated for consent signals while the Zenoti banner adapter is active.
  • If the Zenoti banner is not active or not eligible for the current session, the adapter chain proceeds to detect third-party CMPs in the order listed above.

Tip: If you are transitioning from the Zenoti in-house banner to a third-party CMP, ensure the Zenoti banner is fully deactivated before the third-party CMP goes live. Having both active simultaneously means the Zenoti banner continues to control consent state for all Webstore sessions. For compliance and legal guidance on cookie consent configuration, see Cookie Notice and Necessary Cookies.

Each adapter subscribes to the consent-change event or callback mechanism provided by its CMP. When a guest interacts with the CMP banner and updates their preferences β€” for example, declining analytics cookies after initially accepting all β€” the following occurs:

  1. The CMP records the updated preferences and emits its consent-change event.
  2. The active adapter receives the event and reads the new consent state from the CMP.
  3. The adapter normalizes the updated state into the five-category model.
  4. The Webstore immediately applies the updated consent state.

The guest does not need to reload the page for the updated consent to take effect. Tracking and analytics behaviors governed by the affected consent categories β€” such as conversion tracking or analytics event firing β€” adjust immediately based on the new state.

Note: Consent changes apply to the current page session. On the next page load, the adapter reads the stored consent state from the CMP cookie or global object, so the guest's most recent preferences persist across sessions as long as the CMP cookie is present.

Worked example: A guest visits the Webstore with OneTrust deployed. On first visit, they accept all cookies. The OneTrust adapter detects the OptanonConsent cookie, reads the consent state, and the Webstore enables analytics and advertisement tracking. Later in the session, the guest opens the OneTrust preference center and declines analytics cookies. OneTrust emits the OneTrustGroupsUpdated event. The OneTrust adapter receives the event, updates the normalized consent state to reflect analytics: denied, and the Webstore immediately stops firing analytics events β€” all without a page reload.

Tips

  • Deploy only one CMP at a time. Having multiple CMP scripts on the same Webstore page β€” for example, OneTrust and CookieYes simultaneously β€” can cause unpredictable behavior. Only the first CMP detected in the adapter chain will control consent state, and the others will be ignored. Audit your tag manager or page scripts to confirm only one CMP is active.
  • Test consent changes in a non-production environment first. After configuring or updating your CMP, verify that consent-change events fire correctly and that the Webstore applies updated consent state in real time before rolling out to guests.
  • Coordinate with your CMP vendor on category mapping. The Webstore maps your vendor's categories to the five standard categories. If your CMP uses non-standard category names or a custom taxonomy, work with your CMP vendor to confirm which of their categories correspond to analytics, advertisement, functional, and performance purposes.
  • The IAB TCF v2 adapter requires compliance approval before activation. If your organization's CMP uses IAB TCF v2 signals exclusively and you believe automatic consent reading is required, engage your compliance team before any changes. The IAB TCF v2 adapter is intentionally inactive and must not be registered without explicit approval.
  • Remember the 30-minute cache delay. Changes to your CMP configuration or Webstore template settings may take up to 30 minutes to appear in the guest-facing experience. Plan any consent-related changes with this propagation window in mind.

Troubleshooting

The Webstore is not reading consent from my CMP.

Confirm that your CMP is one of the five supported platforms listed in Supported CMP adapters. If it is, verify that the detection signal your CMP should provide β€” the expected cookie name or global object β€” is actually present on the page when the Webstore loads. Use your browser's developer tools to inspect cookies and page globals. If the detection signal is absent, your CMP may not be initializing before the Webstore's adapter chain runs. Check your CMP implementation and script load order.

My third-party CMP is present, but the Zenoti in-house banner is controlling consent instead.

The Zenoti banner adapter is always evaluated first and takes precedence when active. If you have migrated to a third-party CMP, confirm that the Zenoti in-house banner has been fully deactivated for your organization. If you need assistance deactivating the Zenoti banner, contact Zenoti Support.

Consent changes in the CMP banner are not being applied to the Webstore immediately.

Each adapter subscribes to its CMP's consent-change event. If updates are not being applied immediately, verify that your CMP is correctly emitting the consent-change event listed in the Supported CMP adapters table for your platform. Confirm that your CMP version supports the event and that it is configured to fire on preference updates. Check your browser console for any JavaScript errors that may be preventing the event subscription from functioning.

Guests are seeing all tracking active even though they declined cookies.

If the necessary category is the only one showing as granted and others are still active, this may indicate that the adapter is reading a stale consent state from an old cookie. Ask the guest to clear their browser cookies and revisit the Webstore. The CMP banner should present again, and the adapter will read the fresh consent state after the guest makes their selection.

Our CMP uses IAB TCF v2 signals and automatic consent reading is not working.

The IAB TCF v2 adapter is intentionally inactive in the framework. Organizations whose CMP relies exclusively on IAB TCF v2 are not currently in scope for automatic consent reading. Contact Zenoti Support and engage your legal and compliance teams to discuss options.

Was this article helpful?
Your feedback helps us improve our documentation.