Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

OneTrust Source


Source Info
  • The OneTrust Source is an Event Cloud source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.
  • This source is in Beta

OneTrust makes it easy for you to capture, centralize, govern, and sync consented first party data while keeping trust & transparency at the forefront of all consumer interactions. The OneTrust Integration provides data to Segment's CDP and allows you to view & activate consented data in the appropriate way.

This is an Event Cloud Source which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations.

This source is maintained by OneTrust. For any issues with the source, contact their support team.

(warning)

This page is about the OneTrust source, which lets you send details about end-user consent to Segment destinations

To enforce end-user consent across your destinations, use Segment's Consent Management features.


Getting Started

getting-started page anchor
  1. From your workspace's Sources catalog page(link takes you to an external page) click Add Source.
  2. Search for "OneTrust" in the Sources Catalog, select OneTrust, and click Add Source.
  3. On the next screen, give the Source a nickname configure any other settings.
    • The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (like OneTrust_Prod, OneTrust_Staging, or OneTrust_Dev).
  4. In OneTrust, go to Integrations > Connections > Import and upload the appropriate JSON file.
  5. Copy the Write key from the Segment UI, and paste it in as the Auth header for the OneTrust integration.
  6. Click Save and Activate.

OneTrust uses Segment's stream Source component to send Segment event data. It uses a server-side method(s) to send data to Segment. These events are then available in any destination that accepts server-side events and are available in a schema in your data warehouse, so you can query using SQL.

OneTrust allows you to configure the userId from various sources from within the OneTrust platform.


The following table lists events that OneTrust sends to Segment. These events show up as tables in your Warehouse and as regular events in your other Destinations.

Event NameDescription
Consent UpdatedThe user gave or withdrew consent for an express purpose.

The following table lists event properties included with all events Segment receives from OneTrust.

Property NameTypeDescription
Purpose IDstringThe GUID assigned to the purpose in OneTrust.
Purpose NamestringThe name given to the purpose in OneTrust for which the user gives or withdraws their consent.
StatusstringThe current status of the users consent after the update. Options include ACTIVE, WITHDRAWN, PENDING, OPT_OUT, EXPIRED, NO_CONSENT, HARD_OPT_OUT, and NOT_OPTED_OUT.

Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and verify that events and properties appear the way you expect. If events and properties don't appear as you expect them to, check the Event Delivery tool, and refer to the Destination docs for each tool for troubleshooting.

If there are any issues with how the events are arriving to Segment, contact the OneTrust support team.