Skip to main content

Consent Webhook

Updated

Overview

This document outlines the flow and configuration steps for the Consent Webhook integration. It details how the Webhook mechanism is triggered via user consent actions, how data is propagated, and how to set up and manage Webhook configurations.

Note:

Consent Webhook availability depends on your product and plan. If you are on the Usercentrics Web & App Product, this feature is available as a premium add-on for Premium Customers. If you are on the Usercentrics Platform (latest version), a Corporate plan is required. Check out our pricing page or reach out to your Customer Success Manager for more details.

 

Untitled Diagram-1744711062849.drawio.png

General Flow

When enabled on a settings ID the Consent Webhook integration pushes a copy of all user consents to a configured webhook endpoint. An example of the payload that is pushed is shown below:

{
  "controller_id": "e6952f2110e8442178dedb292c39f69845cc9091e70e95abd9c61391c05155ad",
  "configuration_id": "XxxXXXxx",
  "timestamp": 1744721495920,
  "consent_string": "CQP6E8AQP6E8AAFADAENBlFkAHJAAEBAAIYgF5wBAABAAGAXeAvMFfYAYC7wF5gV9ADHQAYAAgr6FAAwABBX0kABgACCvoAA.YAAAAAAAAAAA",
  "ac_string": "2~43.89~dv.",
  "consents": [
    {
      "consent_status": true,
      "dps_id": "BJ59EidsWQ"
    },
    {
      "consent_status": true,
      "dps_id": "H1Vl5NidjWX"
    },
    {
      "consent_status": true,
      "dps_id": "LykAT-gy"
    },
    {
      "consent_status": true,
      "dps_id": "BJz7qNsdj-7"
    }
  ],
  "webhook_version": "v1"
}

Fields description:

  • controller_id → Key that identifies a set of consent decisions uniquely
  • configuration_id → CMP configuration ID (settingsID)
  • timestamp → When the consent decision was recorded
  • consent_string → TC String; generated after consent decision when a TCF CMP is in use
  • ac_string → Google Additional Consent String; generated with a TCF CMP if Google Vendors are in use
  • consents → Information about individual Data Processing Service (DPS) consent decisions
    • consent_status → DPS-specific consent status (true or false)
    • dps_id → Unique identifier for DPS template in our database
  • webhook_version → A new property that indicates the version of the Webhook payload data

Authorization

All requests will have authorization header with basic auth.

Authorization: Basic bG9ndW46cGFzc3dvcmQ=

Enabling the Webhook Service

  1. Make sure that you are using supported versions:
    1. Web CMP:  version 3.45.0 and above.
    2. Mobile SDK: version 2.20.1 and above.
  2. Contact support and provide following information:
    1. List of settings IDs for which you want to enable the Webhook Service for.
    2. Webhook endpoint.