Getting Started with OneTrust Integrations

Integrations help automate specific tasks or data retrieval from third-party systems, while also helping to create or update data inside the OneTrust application for a more cohesive management experience. Integrations can be leveraged to update third-party marketing systems, create tickets, fulfill data subject requests, manage consent preferences, or facilitate targeted data discovery as part of request fulfillment.

The OneTrust integration ecosystem includes a catalog of pre-integrated applications that make it easy to incorporate privacy by design into your existing application integrations. Additionally, the OneTrust platform enables you to set up a custom integration with systems via APIs, SDKs, data feeds, system integration, and more.

Prerequisites

  • Administrator-level access to the given third-party system console to obtain account details (e.g. Client ID, authorization keys, etc.).

  • Working knowledge or familiarity with your third-party system's supported APIs. Leverage their API or developer documentation for additional guidance.

  • Credentials set up to connect/authenticate third-party systems and OneTrust. For more information, see Configuring Integration Credentials.

Built-In Integrations

OneTrust provides integration templates in our integration gallery for many common business applications. These seeded templates can achieve specific tasks for data subject requests, third-party management, HR data bulk import, consent preferences, and more. These integrations can be used in conjunction with several products

For more information, see Creating Integrations and OneTrust Integrations Gallery.

  1. On the Integrations menu, select Gallery. The Gallery screen appears.

  2. Locate and select a system tile. The Gallery Details screen appears.

    Note:

    Use the filter and search to quickly locate systems. To populate specific system types, select the Web Apps, Databases, or Files tab.

  3. Click the Add button in a block that has a Integration label to create a new integration. The Add integration name modal appears.

  4. Enter an integration name and select the system credential. Then, click the Create button. The Integration Builder screen appears with the seeded integration.

    Note:

    For more information on configuring integration triggers and actions, see Customizing Integration Workflows.

Custom System Integrations

If you want to create an integration that connects to a system for which there are not existing templates, you need to add the system to OneTrust. You can also update existing systems from a JSON file within this modal.

Adding Custom Systems

  1. On the Integrations menu, select Systems. The Systems screen appears.

  2. Click the Add system button. The Add or update a system modal appears.

  3. Complete the fields, then click the Add button.





    Field
    Description
    Import Type

    Select Add System to add a new system.

    Select Add System from JSON to create a system from a JSON file.

    Select Update System from JSON to update a system from a JSON file.

    Name/System

    Enter the name of the system you want to create.

    If you are updating a system, select the system you want to update.

    Description

    A required field to uniquely identify the system's purpose.

    Custom Icon

    Use the file explorer to select the image you want OneTrust to use on the card for the system integration.

    File

    Use the file explorer to select the JSON that describes the system and APIs.

    Note:

    OneTrust provide validation to ensure the JSON is usable for establishing the system and connection.

Download Custom System

  1. On the Integrations menu, select Systems. The Systems screen appears.

  2. Click the tile of a system that is configured with actions. The System Details screen appears.

  3. Click the Export button. The JSON file structure with the API calls will download locally. Use this file to share and import systems.

System Actions

The available actions for the system are determined by the system specification and the API calls available. The built-in systems in OneTrust are pre-populated with commonly used actions that might be helpful for privacy management or other tasks.

You can customize the system actions available by adding new actions or deactivating ones that aren't relevant to your organization.

To add a new system action

  1. On the Integrations menu, select Systems. The Systems screen appears.

  2. Click on the tile for the active integration to which you want to add a system action. The System Details screen appears.

  3. Go to the Actions tab.

  4. Click the Add Action button. The Add Action modal appears.

  5. Complete the fields.

  6. Click the Add button.

To edit an existing system action

Note:

You cannot edit a seeded action. This only applies to custom system actions which you create.

  1. On the Integrations menu, select Systems. The Systems screen appears.

  2. Click on the card for the system for which you want to edit action. The System Details screen appears.

  3. Go to the Actions tab.

  4. Open the Context menu of an action you want to edit, then click View. The Edit Action modal appears.

  5. Edit the fields as necessary.



    Field
    Description
    Action Name

    Enter the name of the action you want to configure.

    Description

    Enter a description of the action.

    Endpoint Path

    Enter the path or URL associated with the endpoint to which the action should connect.

    Note:

    Request URL must include https://

    Method

    Select the method that should be used by the API call:

    • GET

    • PUT

    • PATCH

    • POST

    • DELETE

    Key & Value

    Enter the keys and values which need to be included in the header of the call made by OneTrust.

    Payload Type

    Select a payload type for this new action:

    • json

    • form-url-encoded

    • attachment

    • xml

    Request & Response Body

    Enter the request and response payload of the call necessary to perform the action. 

  6. Click the Save button.

Adding Custom Values

For additional information on this subject, see Custom Values in Integrations.

Note:

Custom values with the same name will take priority based on the scopes in the order: Integration > System > All.

  1. On the Integrations menu, select Values. The Values screen appears.

  2. Click the Add value button. The Add Value modal appears.

  3. Complete the required fields to add details for this new value.



    Field
    Description
    Name

    Provide a unique name for this value.

    Type

    Identify the type of this value as either:

    • STRING

    • DOUBLE: double digit values

    • BOOLEAN: requires enablement

    • DATETIME: requires calendar selection

    • OBJECT

    Value

    Enter the value as you need it to appear in the application.

    System

    Choose for which system this value is available. You can leave this as All so it can be referenced by any system.

    Workflows

    Choose for which integration this value is available. You can leave this All so if can be referenced in any integration.

  4. Click the Create button. The new value will be added to the Values list screen.