Cookie Consent Banner - Setup, Customization & Publishing Guide
Overview
The Cookie Consent Banner integration is designed to ensure compliance with privacy regulations and provide a seamless way for customers to manage user consent on their websites. This feature serves two main purposes:
-
Native Cookie Consent Banner:
-
A customizable cookie banner that can be enabled, modified, and deployed directly on customer websites.
-
Allows users to accept or deny cookies that are used by referral integrations such as:
-
Refer a Friend (RAF)
-
Welcome Messages
-
Conversions and Share Codes
-
-
Once published, the banner will display based on the user's prior consent status.
-
-
Third-Party Cookie Consent Integration:
-
Allows customers who already use a third-party cookie consent service (such as WebtoFee OneTrust, Cookiebot, or TrustArc) to connect their setup with our referral tracking system.
-
Instead of showing an additional banner, our system reads and reuses the existing consent preferences from the third-party service (via LocalStorage or cookies).
-
Native Integration | Step-by-Step Setup Guide
The setup process consists of enabling, customizing, previewing, and publishing the cookie consent banner.
Step 1: Access the Cookie Consent Configuration
-
Navigate to the Editor section of the platform.
-
Locate the "Configure Cookie Consent" button at the top of the screen.
-
If the consent banner has not been configured, an exclamation mark (!) icon will appear next to the button, drawing attention to the user.
-
-
Click the button to open the Cookie Consent Configuration Modal.
Step 2: Enable the Cookie Consent Banner
-
Inside the modal, toggle the option to enable the cookie consent banner.
-
This action does not immediately deploy the banner; it only enables it at the company level.
-
Once enabled, additional customization options will appear.
Step 3: Customize the Cookie Banner
Customers can personalize the banner’s appearance and content to match their brand. Customizable fields include:
-
Title – The main heading of the banner (e.g., "We Value Your Privacy").
-
Description – Short message explaining why cookies are used.
-
Background Color – The banner’s background color.
-
Button Colors – Custom colors for "Accept" and "Deny" buttons.
-
Privacy Policy / Terms Link – URL where users can learn more about data usage.
After making changes, the user can Save the configuration.
Step 4: Preview & Publish
Once the customer has set up the banner, they need to preview it before publishing.
-
Click the "Preview & Publish" button.
-
The system will redirect the user to a live page where one of their existing integrations (RAF, Welcome Message, or Conversion) is active.
-
This page will include authentication parameters in the URL query string, ensuring that the cookie consent preview mode is enabled.
-
-
The banner will be displayed at the bottom of the page, along with a Publish Toggle.
Step 5: Publishing the Cookie Banner
If the customer is satisfied with how the banner looks, they can publish it:
-
Click the Publish Toggle at the top of the cookie consent preview banner.
-
This action sends a request to the API to activate the consent banner.
-
Once published, the banner will automatically show to users who haven’t provided consent yet.
Step 6: Disabling the Cookie Banner
If the customer wishes to disable the consent banner integration:
-
From the Editor open the Cookie Consent Configuration Modal.
-
Click on Preview to access the live preview page.
-
Toggle the Publish Toggle OFF to disable the consent banner.
-
This action sends a request to the API to remove the banner from all pages.
Third Party Cookie Services | Sync & Connection
This option integrates with external consent management platforms, the consent preferences are fetched from the third-party service cookies instead of being handled internally.
Steps to Connect a Third-Party Service
-
Open the Cookie Consent Configuration Modal.
-
Select the "Third-Party Connection" tab.
-
Select a Service Provider from the available list.
-
Choose the Sync Interval – This defines how often the system will fetch updates from the service.
-
Click on the "Sync & Test" button – This will attempt to fetch the consent cookies from the selected service provider.
-
If the cookies are successfully fetched, the connection status label will change to “Connected” and the “Save Configuration” button will be enabled.
-
Click on "Save Configuration" to finalize the integration.
Fallback Scenario: Sync Failure Handling
If the sync process fails to retrieve consent data due to browser restrictions (e.g., SameSite policy, subdomain limitations), the following fallback mechanism will be triggered:
-
The system will detect that the cookies are not accessible from the current environment.
-
A redirection to the customer’s main website will occur (landing page where snippet is installed).
-
The system will attempt to re-fetch the consent cookies directly from the main site.
-
Once retrieved, the consent data will be stored, and the integration will be marked as successful.
-
Click on “Save Configuration” to complete the third party service connection.
This fallback ensures that the third-party service can still be synchronized, even if the cookies cannot be accessed due to browser security constraints.
Questions? Contact your CSM or support@getambassador.com.