Skip to content

Integrations

For seamless integration and accurate mapping of widget elements, obtaining specific IDs (uuId) is crucial. To access the comprehensive widget configuration overview, choose the View Widget Structure menu item from widget menu:

Widget structure overview 1
Widget context menu
Widget structure overview 2
Widget structure overview

The modal opened, contains essential details and identifiers for the widget elements, ensuring a smooth and seamless integration process within your application.

Webhooks

Webhooks are automated messages sent from Preference manager to the external application when widget submission occurred, carrying a payload of data, that contains WidgetID, UserID and set of selections.

Using our administration interface, it is possible to create, update, or delete webhooks linked to specific widgets.

Widget structure overview 2
Webhook settings

To configure a new webhook, follow these steps:

  1. Specify the Title of the webhook, Widget, submission of which will trigger the webhook, and the Webhook URL that will be called when submission event detected;

  2. You can also specify optional Webhook Call Conditions by:

    • selecting Topic: The webhook will be triggered if any option under the specified topic is selected.
    • and additionally selecting Option: If you specify an option under the topic, the webhook will be triggered only when this particular option is selected.

  3. Define the structure of the payload to be sent with the webhook. The payload can include:

    • Widget UUID
    • User ID
    • Answers that can have a different format and composition logic, such as:
      • Format:
        • Only UUIDs - in this case, the payload will contain only UUIDs of the topic and options
        • Titles, UUIDs, and Values - all information will be included, having also Titles and Values (true or false for the selected options)
        • Titles and Values - only Titles and Values (true or false for the selected options). This option might be most user-friendly when using with no-code integration platforms such as Zapier.
      • Logic:
        • All selected options - all selected choices to be included in the payload
        • Only updated options -Only the updated options will be included in the payload, with a true value for selected options and false for unselected options.

  4. For endpoints that require authentication, you can specify one of the following methods:

  5. API Key
  6. Basic Authentication including username and password

By configuring these settings, you ensure that the webhook operates as intended, triggering under the specified conditions and sending the appropriate payload to the designated URL.

Currently only preference submission event triggers the webhook call.

Example of webhook payload sent to a third-party URL once the widget is submitted:
Example of payload with only UUIds 

{
  "userId": "end-user@domain.com",
  "widgetId": "b07d0da4-197d-4246-9d57-5fbe6da13cc0",
  "answers": [
    {
      "topicUuid": "92b5326a-f42a-4e87-bf44-e35d814b37fc",
      "optionUuids": [
        "4f9e4e79-7948-4869-8caf-693aa439262f",
        "f9a9e5ec-bd2e-4050-aea4-3aa62a29351a",
        "7bfa2f03-9af0-4dbd-ba83-fde98095c762"
      ]
    },
    {
      "topicUuid": "7b9aa75e-7d9d-4666-b202-5d8ce1ce78d1",
      "optionUuids": [
        "sdf9aa75e-7d9d-3266-b202-5d8ce1ce1231"
      ]
    }
  ]
}
Example of payload with UUIds UUIDs, Titles and Values

```{ "widgetId":"a25be8a3-a064-...-29af0e8343ec", "userId":"user@company.com", "answers":[ { "title":"Please select newsletter topics you are interested in", "uuid":"4f9e4e79-....-693aa439262f", "options":[ { "title":"Weather", "uuid": "7b9aa75e-....-5d8ce1ce78d1", "checked":"true }, { "title":"Sport", "uuid": "7b9aa75e-....-5d8ce1ce123d", "checked":"true } ] } ] } 

**Example of payload with UUIds Titles and Values**

```{
 "widgetId": "a25be8a3-a064-...-29af0e8343ec",
 "userId": "user@company.com",
 "answers": {
    "Please select newsletter topics you are interested in": {
        "Weather": true,
        "Sport": false
    }
  }
}

Integration with Usercentrics CMP

Please note that the Cross-Device Consent Sharing feature should be available and activated for the CMP configuration.

Customers that use both the Usercentrics CMP and Preference Manager products can benefit from and implement a Cross-Device Consent Sharing CMP feature using the Usercentrics Preference Manager’s capabilities.

Once the end user is authenticated on the website and the JWT token is available on the page (this token represent the identified user, and can be obtained by calling our public API end-point server-side as described here), our script will save the link between the UserID of the end user and current cookie consent session identifier (ControllerID). Later, when the user is logged in to the website on a different device, we can retrieve it and restore the cookie consent session that was initially active. This way cookie consent settings sessions will be bound to a specific individual and will be respected on every visit when your website can identify the user.

We strongly recommend implementing such consent session synchronization only with explicit consent from the end user, which can be also stored in one of the widgets available in the same Preference Center configuration.

To set up such an integration, please complete the following steps: 1. Make sure Cross-Device Consent Sharing is available and activated for the corresponding CMP configuration. 2. Configure the integration on the Usercentrics Preference Manager side by adding the CMP Configuration ID. 3. You can also define a source of user consent to allow specific user to decide if they want their consent session to be binded with their UserID or not. If selected, binding UserID and ControllerID with consent session synchronization will happen only if the option specified contains a value. If you obtain such consent outside Preference Center tool, you can skip this step. 4. Add a specific Javascript library onto the page. 5. Once the end user-specific JWT token is available, it should be used as a parameter in the syncSession() function to restore the consent session (see example below). Please note, in case of empty, or incorrect JWT token, script will through an error into console.

Configuring CMP integration
Configuring CMP integration

Synchronization script library that needs to be added onto the web page:

<script src="https://cmp-sync.preference-management.usercentrics.eu/latest/sync-data.js"></script>

Example of the HTML page that implements the Cross-Device Consent Sharing CMP feature using Usercentrics Preference Manager: 

  <script>
    const ucPMToken = 'JWT_TOKEN_HERE';
    window.syncSession(ucPMToken)
     .then(result => {
        console.log('Sync session result:', result);
     })
     .catch(error => {
        console.error('Error syncing session:', error);
     });
  </script>

Data Connectors

Google Customer Match

Google Customer Match requires advertisers to use first-party data, which must be collected with explicit consent and an auditable consent record. Additionally, Google requires advertisers to have a good history of compliance with their EU user consent policy. The GDPR mandates that data subjects must be able to freely manage and revoke their consent as easily as it was given, which can be easily done with our native Data Connector.

The integration allows: - Automatic syncing of user consent decisions and email addresses to Google Customer Match when users opt-in, and automatic removal of user data from Google Ads audiences when users revoke their consent. - Simplified compliance with GDPR and Google’s consent requirements supported by consent history logs records are stored securely, supporting compliance audits and reporting needs.

Select consent source
Select consent source

As the next step, you will be offered to authenticate using Google SSO and provide necessary permissions to our platform to enable smooth data transition into your Customer list.

Select consent source

Example Workflow

  1. User Action: A user opts into sharing first-party data with Google a Preference Center’s widget.
  2. System Action: The Data Connector captures the user’s email (as user’s ID) and consent status and sends this information to Google Customer Match.
  3. Sync Timing: The information is added to the Google Ads audience during the next 24-hour sync cycle.
  4. Revocation Handling: If the user later opts out, their information is removed from the audience in the next sync.

With this integration, you can efficiently manage consented data for your Google Ads campaigns while maintaining compliance with user privacy regulations.

Pardot Data Connector

Please note that the Pardot data connector is an internal feature without a user interface. To set up integration, contact our Product team.

Every widget within the Preference Manager can be configured to connect with an instance of Salesforce Pardot (Account Engagement). This enables users to manage their subscriptions to Pardot mailing lists via Usercentrics Preference Manager. To set up this integration, refer to our Usercentrics dev team for assistance with the following steps:

Step 1: Submit Pardot integration credentials

{
  "pardotBusinessUnitId": "", 
  "grantType": "",           // i.e. "password" 
  "clientId": "",
  "clientSecret": "",
  "userName": "",
  "password": "" // password+SecurityToken
}

Step 2: Set up mapping between OptionID and Pardot mailingListID. The mapping should include optionUuid, representing the ID of a specific Option within the given widget, and mappedUuid, representing the ID of the Mailing list within Pardot.

{
  "mappedValue": [
    {
      "optionUuid": "string",
      "mappedUuid": "string"
    }
  ]
}

Leveraging webhooks and data connectors empowers your Preference Manager integration, facilitating seamless data exchange and enhancing user experience. For additional guidance or support, consult our technical documentation or reach out to our dedicated support team.

Data Connectors for Other Tools

Data connectors for other tools are available upon request. Contact our product team to learn more.

See Also