Skip to content

Commit a8b4624

Browse files
Merge pull request #8099 from segmentio/DOC-1291
Segment's OneTrust wrapper automatically populates consent object [DOC-1291]
2 parents 4397469 + fa47ec8 commit a8b4624

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

src/privacy/consent-management/configure-consent-management.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Before you can configure consent in Segment, take the following steps:
3939
4040
## Step 2: Integrating your CMP with Segment
4141

42-
Once you've created consent categories in the Segment app, you need to integrate your CMP with Segment.
42+
Once you've created consent categories in the Segment app, you need to integrate your CMP with Segment and add the consent object to every event. If you're using Segment's OneTrust wrapper, the consent object automatically populates on each event. However, other methods may require you to manually include the consent object on your events.
4343

4444
Segment supports the following CMPs:
4545

@@ -56,7 +56,7 @@ Segment supports the following CMPs:
5656
5757
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 following requirements for data and event generation:
5858
- Reads the end user consent preference from your CMP and includes the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object) in every event
59-
- If using Unify and Engage, generates the [Segment Consent Preference Updated](/docs/privacy/consent-management/consent-in-unify/#segment-consent-preference-updated-event) event every time a user provides or updates their consent preferences with their anonymousId and userId
59+
- If using Unify or Twilio Engage, generates the [Segment Consent Preference Updated](/docs/privacy/consent-management/consent-in-unify/#segment-consent-preference-updated-event) event every time a user provides or updates their consent preferences with their anonymousId and userId
6060

6161
To get started building your own wrapper, follow the instructions in the [@segment/analytics-consent-tools](https://github.com/segmentio/analytics-next/tree/master/packages/consent/consent-tools){:target="_blank"} repository.
6262

src/privacy/consent-management/consent-in-segment-connections.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ If your sources also contain the integrations object, Segment looks at the conse
2020
2121
## Consent object
2222

23-
Segment requires every event from all of your sources to include the end user consent preferences, captured by your CMP or your application logic, in the form of the **consent object**. The consent object is a JSON object nestled inside of the [context object](/docs/connections/spec/common/#context) with the following format:
23+
Segment requires every event from all of your sources to include the end user consent preferences, captured by your CMP or your application logic, in the form of the **consent object**.
24+
25+
The consent object is a JSON object nestled inside of the [context object](/docs/connections/spec/common/#context) with the following format:
2426

25-
> success ""
26-
> The JSON keys in the consent object should represent the `categoryId` for each consent category.
2727

2828
```json
2929
{
@@ -41,9 +41,12 @@ Segment requires every event from all of your sources to include the end user co
4141

4242
```
4343

44-
Events without the consent object continue to flow to destinations without consent enforcement.
44+
> success ""
45+
> The JSON keys in the consent object should represent the `categoryId` for each consent category.
46+
47+
[Segment's OneTrust wrapper](/docs/privacy/consent-management/configure-consent-management/#step-2-integrating-your-cmp-with-segment) automatically adds the consent object to your events, but you can also manually add the consent object to your events if you're using a different CMP.
4548

46-
Events that don't include a context object, a consent object, or that include them but leave them empty, don’t affect [Profile-level consent preferences](/docs/privacy/consent-management/consent-in-unify) and flow to all destinations.
49+
Events without the consent object continue to flow to destinations without consent enforcement. Events that don't include a context object, a consent object, or that include them but leave them empty, don’t affect [Profile-level consent preferences](/docs/privacy/consent-management/consent-in-unify) and flow to all destinations.
4750

4851
## Reconcile consent conflicts
4952

0 commit comments

Comments
 (0)