Configure Consent Management

After setting up your consent management platform (CMP), you can enforce the consent collected from your users by adding the consent object to your events.

Once you’ve configured consent in the Segment app and updated your sources to contain consent preference in every event, your events are routed only to the categories your end users consented to share data with. Events without the consent preference will continue to flow to destinations without consent enforcement.

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 and mobile libraries. After you set up consent categories in the Segment app, you need to integrate your CMP and your Segment sources using a wrapper or other solution.

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: Integrating your CMP with Segment

Once you’ve created consent categories in the Segment app, you need to integrate your CMP with Segment. Segment recommends using a CMP wrapper, but you can use any solution provided it meets the following criteria:

• Reads the end user consent preference from your CMP and includes the consent object in every event
• If using Unify and Engage, generates the Segment Consent Preference Updated event every time a user provides or updates their consent preferences with their anonymousId and userId

Segment provides a OneTrust wrapper for the following sources:

• Analytics.js: Please follow the instructions from the README in the @segment/analytics-consent-wrapper-onetrust repository. For more information about Segment’s Analytics.js OneTrust wrapper, see the Analytics.js OneTrust Wrapper documentation.
• Kotlin: Please follow the instructions from the README in the @segment-integrations/analytics-kotlin-consent repository.
• Swift: Please follow the instructions from the README in the @segment-integrations/analytics-swift-consent repository.

If you’d like to integrate with any other CMP, Segment requires you to build your own wrapper or use any mechanism provided it meets the above requirements of data and event generation. To get started building your own wrapper, follow the instructions in the @segment/analytics-consent-tools repository.

Validate your CMP integration

Customers with Analytics.js 2.0 sources can use the Segment Inspector to confirm that events from their source contain the consent object. Unify and Engage users can also verify that the Segment Consent Preference Updated event emits every time end users update their consent preferences.

All users can validate that events contain the consent object and that the Segment Consent Preference Updated event is present using Segment’s Source Debugger.

You can also confirm your events flow to destinations or are blocked from destinations according to the consent categories you created in Step 1: Create consent categories in the Segment App, if already connected to the destination.

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.