Didomi - Developers documentation
  • Introduction
  • SDKs
    • Introduction
    • Web SDK
      • Getting started
      • Tags and vendors management
        • Tags management
          • Events & Variables
            • Deprecated
            • Custom events
          • Tag managers
            • Adobe Launch/DTM
            • Eulerian
            • Google Tag Manager
              • Configure the Didomi / GTM integration
              • Didomi's GTM template
            • Tealium
            • Other tag managers
        • Custom Didomi <script> tags
        • Third-party integrations
          • Google Ad Manager / AdSense
            • GDPR via Non-Personalized Ads
              • Share consent and load/refresh ads
              • Share consent without loading or refreshing ads
            • US states laws
          • Google Consent Mode V2
          • Kameleoon
          • Piano Analytics (AT Internet)
          • Prebid
            • GDPR via IAB TCF
            • US states laws
          • Salesforce DMP (Krux)
        • IAB frameworks
        • Programmatic API
      • Configuration
        • Bots (SEO & Performance tools)
        • Configuration by URL
        • Cookies and storage
        • Custom domains for events
        • Notice
          • Behavior
          • Interactions
          • Look and feel
        • Preferences
        • Theme
      • AB tests
      • Custom domain
        • Domain delegation
        • Reverse proxy
      • Share consents between domains
      • Share consents across devices
      • Pass user choices in query string
      • Serve Didomi assets from your domain
      • Reference
        • API
          • Deprecated
        • Events
      • Performance
    • Mobile and TV SDKs
      • Android and Android TV
        • Setup
        • Logging
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • iOS and tvOS
        • Setup
        • Logging
        • App Tracking Transparency (iOS 14.5+)
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • Unity
        • Setup
        • Reference
        • Versions
        • Troubleshooting
      • React Native
        • Setup
        • Reference
          • Deprecated
        • Versions
      • Flutter
        • Setup
        • Reference
        • Versions
      • Consent notice
        • Getting started
        • Customize the notice
        • Customize the preferences popup
        • Customize the theme & UI
        • Load notice by ID
      • Third-party SDKs
      • Share consents across devices
      • Share consent with WebViews
      • Google Consent Mode v2
      • FAQ
    • AMP SDK
      • Blocking Behaviors
        • Load immediately on page load
        • Load only after consent (positive or negative)
        • Load only after positive consent
      • Consent status for vendors
    • Help & Support
  • API
    • Introduction
      • Authentication
      • Errors
      • Pagination
      • Filters
      • Caching
      • Rate limiting
      • Quotas
      • Translations
    • Data Manager
      • Regulations
      • Configuration Tree
      • Purposes
        • Purposes & Vendors Numerical IDs
      • Preferences Library
      • User Rights
    • Widgets
      • Consent notices
        • Notices
        • Configurations
        • Multi-Regulation Configurations
          • Migration of Existing Notices and API Updates
        • Deployments
        • Tutorials
          • Create and publish a consent notice
          • Create and publish a multi-regulation consent notice
      • Privacy widgets
        • Create a widget
        • Retrieve widgets
        • Edit a widget
          • Content & Design
            • Themes & Shapes
            • Components
              • auth
              • dsar_form
              • footer
              • header
              • preference
              • preference_value
              • save
              • section
              • sections
            • Options
          • Purposes & preferences
          • Settings
        • Deploy a Widget
          • Use your own subdomain
          • Use your own domain
          • Implement an embeddable widget on your website
        • Authentication
          • Manage authentication providers
          • Authenticate your end-user
        • Archive a widget
        • Headless widgets
          • Public Methods
          • Custom elements
          • Custom events
          • Event listeners
        • Tutorial
          • Launch a Preference Center from a mobile app
    • Compliance Reports
      • Properties
      • Reports
      • CSV format reference
      • Websites
    • Consents and Preferences
      • Events
        • Generate IAB TCF consent string
      • Links
      • Proofs
      • Tokens
      • Secrets
      • Users
      • Tutorial
        • Collect and operate data
    • Privacy Requests
      • Requests
      • Notes
      • Links
      • Emails
  • Integrations
    • Introduction
      • Quotas
    • Generic integrations
      • Batch export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
        • Exported data
          • Notices consents
        • Logs
      • Webhooks
      • Batch import
      • Analytics export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
    • Third-party apps
      • CMP integrations
        • Didomi-mParticle integration for your CMP
        • Deploy Didomi’s SDK for your Adobe Commerce website
      • Preference Management Platform integrations
        • Actito
        • Adobe Campaign Classic
        • Adobe Experience Cloud
        • Adobe Marketo Engage
        • Adobe Source Connector
        • Braze
        • Dotdigital
        • Hubspot
        • Mailchimp
        • Microsoft Dynamics 365
        • Salesforce Marketing Cloud
        • Salesforce Sales & Service Cloud
        • Selligent
        • Brevo (ex Sendinblue)
    • Tutorials
      • Configure a HTTP webhook
      • Configure a batch export
      • Configure an analytics export
    • Emailing
      • Configurations
        • Actito Email
        • Actito SMS
        • Adobe Campaign Classic
        • Adobe Campaign Standard
      • Emails
        • Templates
        • Manage your templates
Powered by GitBook
On this page
  • Available integrations
  • Batch export
  • Webhooks
  • Consents API
  • What integration should I use?
  • Criteria
  • Decision matrix
  • Use cases
  1. Integrations

Introduction

PreviousEmailsNextQuotas

Last updated 1 year ago

Integrations are used for getting user choices from the Didomi Platform to your internal services or to third-party vendors that you use internally for emailing, user management, analytics, etc. They allow you to leverage consent data collected by Didomi in all your existing tools.

Integrations are subject to separate pricing from our CMP and Preference Center products. Please reach out to our Support team () to get more information.

Available integrations

Batch export

The Didomi Platform exports all user consent data collected at a fixed interval (usually daily). The data is exported to cloud object stores like AWS S3 or GCP Storage.

Webhooks

The Didomi Platform notifies an HTTP endpoint every time a new user choice is collected. The data is streamed in real-time to your services.

Consents API

The Didomi Platform exposes all user choices via an API that you can leverage to build your own custom consent solutions.

We guarantee backwards compatibility with our APIs and other interfaces by not removing properties or otherwise altering existing functionality. We may add new properties over time. If you are validating our response against your own internal schemas, it is a recommended practice to ignore unknown fields or skip them from your deserialization logic to not throw errors. Breaking changes or future API versions will be communicated in advance.

What integration should I use?

We often get the question of what integration method should be used for a specific use case.

Criteria

Choosing the right integration for your problems should be driven by 4 criteria:

  • Push/pull model: Does the Didomi platform push user choices to your services (push) or do your services pull data from the platform (pull)?

  • Delivery lag: How fast are the user choices data made available for consumption by your services?

  • Scalability: How many user choices can be read and at what speed?

  • Risk of loss: Can user choices be lost during transfer if your services are unavailable at any point?

Decision matrix

Based on the 4 criteria defined above, you can use the following matrix to decide what integration best fits your use case:

Push/pull model

Delivery lag

Scalability

Risk of loss

Consents API

Pull

Real-time

One user choice at a time

Getting all user choices for a given organization is not practical with this method

No risk of loss

Batch export

Push

>= 24 hours

All user choices at once

No risk of loss

Webhooks

Push

Real-time

One user choice at a time

Risk of loss if your service receiving the events is unavailable

Use cases

The most common use cases that we see for our integrations are:

Use case

Description

Recommended integration

Analytics/BI/Reporting

Leverage your existing BI tools to build custom reports that the Didomi Platform does not expose or advanced metrics that require joining your consent data with your own internal business data.

Batch export

Backup

Keep a full copy of the consent data of your organization for compliance or safety purposes.

Batch export

Integration with vendors

Push consent data into your third-party vendors that need it for business operations (marketing campaigns, analytics, etc.).

Webhook or Batch export

Internal services

Leverage consent data in your internal services.

API or Webhook

support@didomi.io
Read more about batch export.
Read more about webhooks.
Read more about the Consents API.