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
      • Versions
    • 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
  • Introduction
  • Implementation
  • Connection
  • Options
  • Mapping
  • Configuration
  • Example
  1. Integrations
  2. Third-party apps
  3. Preference Management Platform integrations

Braze

PreviousAdobe Source ConnectorNextDotdigital

Last updated 1 year ago

Braze integration is in beta version, please contact if you want to test it.

Introduction

Didomi allows you to update your Braze contact attributes with the preferences collected through your preference management platform (PMP).

Implementation

Connection

Didomi connects to Braze on your behalf through API calls using the API key and the Server instance of your Braze account. Therefore, every time preferences are collected using the Didomi Platform, it triggers an event that updates the attributes of your Braze users.

You can use the Didomi user's property organization_user_id to identify and link your users on both platforms.

Options

  • Upsert mode: Please note that the Upsert mode is not supported for this connector.

  • Bidirectional flow: Please note that the bidirectional flow is not supported at the moment.

Mapping

Didomi uses the entity user of Braze and supports the following user updates:

  1. Opted-in: means the user has explicitly chosen to receive email campaigns. This mapping option can be used in your Braze integration through the id OPTED_IN in the properties object.

  2. Unsubscribed: means the user has explicitly chosen to unsubscribe from getting email campaigns. To use this mapping option in your Braze integration, you need to use the id UNSUBSCRIBED under the properties object, and map it with a purpose or a preference value from your PMP.

  3. Subscription to a custom group: If you chose to segment your audience through , Didomi also allow you to add/remove users from those groups based on their preference choices. You will simply need to map your subscription group id with a purpose or a preference from your PMP.

Configuration

Didomi needs the following configuration items to set up the connection with Braze:

Property
Description
Required

API key

An API key of Braze account

Yes

Server

Server instance of Braze account

Yes

Mappings

List of properties to match between Didomi and Braze

Yes

Example

{
    "type_id": "braze",
    "authentication": {
        "api_key": "Your Braze API Key",
        "server": "Your Braze server URL",
    },
    "properties": {},
    "mappings": [
        {
            "id": "OPTED_IN", // Native state in braze to tag the users who have explicitly opted-in to receive emails.
            "value": "consents_purposes_<purpose>_enabled"
        },             
        {
            "id": "UNSUBSCRIBED", // Native state in braze to tag the users who have explicitly unsubscribed from emails.
            "value": "consents_purposes_<purpose>_enabled"
        },
        {
            "id": "subscription_group_id", // Custom Subscription group that could be created in Braze
            "value": "consents_purposes_<purpose>_enabled"
        }
    ],
    "upsert_mode": true
}

The configuration of the Braze integration can be done in the . First please reach out to to get the integration's premium feature activated.

support@didomi.io
custom subscription groups
Didomi Console
support@didomi.io