How to Integrate with Braze

Braze is a customer engagement platform that powers relevant, personalized customer experiences in real-time. Digioh integrates with Braze to collect and pass customer data from pop-up forms, quizzes, surveys, landing pages, and preference centers.

Follow these steps to set up your Braze integration.

Note: If you are setting up a Digioh integration by yourself, we first recommend reading about Digioh Integration Basics.

1. Log into your Digioh account

2. Click “Integrations.”

3. Click the New Integration button.

4. Name your integration, then select Braze from the dropdown menu.

add new braze integration to digioh

5. Enter Braze API key (For your Braze API key, please check Braze API documentation)

Note: While Creating the API key Select the User data Permission that is needed for adding the users to braze

enter braze api key

6. Enter Braze /users/track API Endpoint.

Braze manages a number of different instances for dashboard and REST Endpoints. When your account is provisioned you will log in to one of the following URLs. Use the correct REST endpoint based on which instance you are provisioned to. If you are unsure, use the following table to match the URL of the dashboard you use to the correct REST Endpoint.

Note: Once you logged in you’re braze account it will open the braze dashboard from where you can see the dashboard URL (See below screenshot) and get the Rest end point from the below table.

 

INSTANCEURLREST ENDPOINT
US-01https://dashboard-01.braze.comhttps://rest.iad-01.braze.com
US-02https://dashboard-02.braze.comhttps://rest.iad-02.braze.com
US-03https://dashboard-03.braze.comhttps://rest.iad-03.braze.com
US-04https://dashboard-04.braze.comhttps://rest.iad-04.braze.com
US-05https://dashboard-05.braze.comhttps://rest.iad-05.braze.com
US-06https://dashboard-06.braze.comhttps://rest.iad-06.braze.com
US-08https://dashboard-08.braze.comhttps://rest.iad-08.braze.com
EU-01https://dashboard-01.braze.euhttps://rest.fra-01.braze.eu
EU-02https://dashboard-02.braze.euhttps://rest.fra-02.braze.eu

 

enter the integration endpoint

7. Format your payload like this

{
    "attributes" : [
         {
           "external_id": "[EMAIL_MD5]",
           "email" : "[EMAIL]"
         }
     ]
}

 

You can add additional custom fields as needed:

For example, for adding the box name and source you can use the following payload

Here is the

{
    "attributes" : [
         {
           "external_id": "[EMAIL_MD5]",
           "email" : "[EMAIL]",
           "box_name": "[LIGHTBOX_NAME]",
           "source": "[SUBMIT_URL]"  
         }
     ]
}

Here is the list of fields that digioh can push:

Digioh Analytics Fields Example

{
    "attributes" : [
         {
            "external_id": "[EMAIL_MD5]",
            "email" : "[EMAIL]",
            "vendor_id": "[VENDOR_ID]",
            "lightbox_id": "[LIGHTBOX_ID]",
            "lightbox_name": "[LIGHTBOX_NAME]",
            "variation_id": "[VARIATION_ID]",
            "variation_name": "[VARIATION_NAME]",
            "ab_test_id": "[AB_TEST_ID]",
            "client_id": "[CLIENT_ID]",
            "submission_id": "[SUBMISSION_ID]",
            "city": "[CITY]",
            "region": "[REGION]",
            "country": "[COUNTRY]",
            "country_code": "[COUNTRY_CODE]",
            "postal_code": "[POSTAL_CODE]",
            "web_source": "[WEB_SOURCE]",
            "search_engine": "[SEARCH_ENGINE]",
            "device": "[DEVICE]",
            "operating_system": "[OPERATING_SYSTEM]",
            "browser_type": "[BROWSER_TYPE]",
            "browser_version": "[BROWSER_VERSION]",
            "page_visits": "[PAGE_VISITS]",
            "past_visits": "[PAST_VISITS]",
            "referring_url": "[REFERRING_URL]",
            "landing_url": "[LANDING_URL]",
            "submit_url": "[SUBMIT_URL]",
            "submit_date": "[SUBMIT_DATE]"
         }
     ]
}

8. If you want to connect the integration to a Box at this time, select the Box from the dropdown. Then, click Create Integration.

You are all set!

If you have questions about setting up your Braze integration, send us an email, and we’ll be glad to help!

Note: This integration only adds users to your Braze account. We also have advanced Braze integrations to push custom fields, add users to subscription groups, read data from your Braze account, and delete/update users. Contact us to set this up for you.

Related Reading:

Tagged: