About Consent Apps

In This Article

This article is a comprehensive guide for consent app creators that explains everything you need to know about managing consent policies on Wix sites.

Only 1 consent app should be installed on a site at a time to avoid conflicting changes to consent settings. Make sure you convey this to your users.

Before you read this article, make sure you're familiar with the GDPR and the cookie consent requirements that Wix apps must implement. For information on these topics, see About GDPR and Data Protection Compliance.

There are 2 types of consent policies to be aware of when developing a consent app:

Visitor consent policies
Default consent policies

Every visitor to a Wix site has their own visitor consent policy that defines what types of cookies and related technologies they allow.

Visitor consent policies can be managed using the Consent Policy API.

When a visitor first arrives on the site, their visitor consent policy is configured to match the site's default consent policy.

Every site's default consent policy initially allows all types of cookies and related technologies. You can manage a site's default consent policy using the Site Properties API.

Example use cases

You're developing an app that adds a cookie consent banner to a site. When the visitor chooses their consent settings in the banner, you call setConsentPolicy() to update their policy with their chosen settings.

Implementation examples

Basic consent banner HTML fragment for an embedded script using the Consent Policy Manager API

Copy

Basic consent banner React component using the Consent Policy Manager API

Copy

You're developing an app with a cookie consent banner. When a user installs and activates your app, you want to block all types of cookies and related technologies until the visitor specifically consents to them via your banner. To do this, you configure a dashboard page where the user can activate your banner. When they activate it, you call updateConsentPolicy() with all consentPolicy types except essential set to false. If they deactivate your banner, you call updateConsentPolicy() again to reset the default site consent policy to allow all types.

Implementation examples

The following are examples of functions you could implement to enable or disable a consent banner, such as in a dashboard page in your app.

Javascript SDK backend implementation example

Copy

REST API implementation example

Copy

Required extensions

When creating a consent app, you'll need at least the following extensions:

Embedded script extension: You'll need an embedded script to load interactive functionality that allows site visitors to specify their consent settings, such as a cookie consent banner. Embedded scripts run on every page of a site, so regardless of the visitor's entry point, they will be given the option to configure their consent settings.
Dashboard page extension: You'll need a dashboard page extension to allow users to activate or deactivate your app, customize your app's settings, and complete the setup of embedded scripts.

Your app can optionally manage the consent categorization of scripts in other Wix apps.

Every embedded script in a Wix app must have a category, also referred to as a type. These categories are used to classify scripts for consent purposes according to GDPR and other data protection guidelines. Read more about embedded script categories.

You can override the consent categories for installed apps' embedded script extensions using the Consent Configs API. For example, you could create a dashboard page that allows the site owner to manage the consent categories of other apps they have installed.

Testing your app

It's important to test your app's consent functionality to ensure it functions correctly. We recommend the following flow to test your app:

Install your app on a new site and check that no scripts are blocked.
Enable your app in your dashboard page.
Visit your site and check that your app's interface, such as a banner, appears.
Check that all non-essential scripts are now blocked by the sites default consent policy.
Check that making and accepting changes in your app's interface triggers a call to update the visitor's consent policy, and that when this happens, any unblocked scripts start running.
Check that turning off the banner in your dashboard page changes the site's default policy back to allowing all categories.