Introduction

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 ([e-mail]) 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.

Read more about batch export.

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.

Read more about webhooks.

Consents API

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

Read more about the Consents API.

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