Configure Consent Management

After setting up a third-party consent management platform (CMP), you can enforce the consent collected from your users by configuring consent categories in your your Segment workspace and adding the consent object to your web libraries.

Once you’ve configured consent in the Segment app, your events are routed only to the categories your end users consented to share data with.

Prerequisites

Before you can configure consent in Segment, take the following steps:

• Set up your third-party consent management tool and create consent categories. Take note of your consent categories and the key or ID associated with each category.
• Know how your company uses each destination. You need to know which destinations to map to each category.
• Access to your web libraries. After you set up consent categories in the Segment app, you need to add a wrapper to your Analytics.js snippet so that Segment can receive your end users’ preferences. Segment provides a wrapper for OneTrust, or if you’re using a different CMP, you can create your own wrapper using the instructions provided in the analytics-next repository.

Step 1: Create consent categories in the Segment app

1. From the Segment homepage, select the Privacy tab and click Consent Management.
2. On the Consent management page, click Create categories.
3. Confirm that you have completed the required prerequisites, and click Next.
4. On the Create consent categories page, add the following information to the category form:
   • Category name: Enter a name that describes your use case for the data sent to this destination. This field only accepts category names that are 20 characters or less.
   • Category ID: In OneTrust, this is a string of up to five alphanumeric characters, but other CMPs may have a different format. This field is case sensitive.
   • Mapped destinations: Select one or more of your destinations to map to this category. Category mappings apply to all instances of a destination.
     
     Optional: Click Add category to create another category.
5. Once you’ve finished setting up your category or categories, click Save.

Step 2: Add the consent wrapper to Analytics.js

If you’re using OneTrust as your CMP, you can install the OneTrust integration consent wrapper (@segment/analytics-wrapper-onetrust) using a snippet or npm.

If you have a CMP other than OneTrust, you can install the @segment/analytics-consent-tools package using the instructions in the analytics-next repository.

OneTrust for snippet users (window.analytics)

Delete the analytics.load() line from the snippet in the header of your website:

- analytics.load("<MY_WRITE_KEY>");

Run the following initialization code in your project, replacing <MY_WRITE_KEY> with your write key:¹

import { oneTrust } from '@segment/analytics-consent-wrapper-onetrust'


// snippet users
oneTrust(window.analytics)
window.analytics.load('<WRITE_KEY>')

OneTrust for npm library users

Initialize the OneTrust wrapper by running the following code on your command line, replacing <MY_WRITE_KEY> with your write key:¹

import { oneTrust } from '@segment/analytics-consent-wrapper-onetrust'
import { AnalyticsBrowser } from '@segment/analytics-next'

export const analytics = new AnalyticsBrowser()

oneTrust(analytics)

analytics.load({ writeKey: '<MY_WRITE_KEY'> })

¹: You can find your write key by navigating to Connections > Sources > [Source Name] > Settings.

Edit consent categories

If you need to make changes to your consent categories, you can edit them on the Consent Management page. You may experience some latency between making the changes and having the changes take effect.

1. From the Segment homepage, select the Privacy tab and click Consent Management.
2. On the Consent Management page, navigate to the consent category you’d like to edit and click Edit.
3. On the Edit consent category page, you can make changes to the consent category name, ID, and the destinations connected to a category.
4. When you’ve made your changes, click Save.

Disable consent categories

Disabling a consent category means that Segment no longer enforces end user consent preferences for the destinations in the disabled category. Other consent categories aren’t affected.

1. From the Segment homepage, select the Privacy tab and click Consent Management.
2. On the Consent Management page, disable the toggle for the category you’d like to disable.
3. On the “Disable [category-name]?” popup, enter the category name in the Consent category name field and click Disable category.