Braze
This integration is in beta
As with all beta tests, not everything will be perfect. If you run into any issues, please submit a support ticket.
Braze is a customer engagement platform that helps brands deliver personalized, cross-channel experiences in real time. Connecting Lexer and Braze lets you sync enriched customer segments for more targeted campaigns while importing Braze customer records and engagement data into Lexer to enhance profiles.
Benefits
Integrating your Braze account with Lexer provides the following benefits:
- Import Braze customer profiles, email engagement, and SMS engagement data into Lexer
- Sync segments from Lexer into Braze as custom properties
- Sync attributes from Lexer into Braze as custom properties
Our Braze integration at a glance:
Direction
What direction does the data flow?
✅ Data source: enrich profiles in Lexer
✅ Data destination: send Lexer segments, events, and attributes to Braze
Type
Lexer loads these types of data
⬜️ SMS
Source method
How Lexer loads data from this source.
✅ API
✅ File (S3)
Destination method
How Lexer sends data to this source.
✅ API
Status
What is the status of the integration?
Full Release
Lexer product compatibility
What Lexer products is the integration compatible with?
✅ Activate
✅ Compare
✅ Segment
✅ Track
Attributes
No attributes will be created as part of this integration.
Attributes
This integration allows for some flexibility, the output of the integration depends on your available data and what you send through to Lexer. In addition, your attributes could be named in a different way to other clients. If you would like a list of attributes related to this integration, please email your Success Manager.
Attributes
What attributes are created when integrated with Lexer?
Attributes
These are the standard attributes that Lexer can create from the data received via this integration. The exact attributes will depend on what data is made available and sent into Lexer. Keep in mind, your attribute names may vary slightly. If you have any questions or would like to explore custom options, please contact your Success Manager.
Customer attributes
Address
Birth day
Birth month
Birth year
City
Communication opt in
Country
Customer id
Date of birth
Employee flag
Engage id
First name
Full name
Gender
Generation
Inferred gender
Last name
Mobile
Next birthday
Postcode
Provider id
Record
State
Username
Zip
Email engagement attributes
Email campaigns clicked
Email campaigns opened
Email campaigns sent
Email click date
Email click rate
Email email engagement category
Email emails sent
Email last click date
Email last open date
Email open date
Email open rate
Email opt in status
Email source
Email subscribe date
Email sha256
ESP record
SMS event attributes
Transactional attributes
Product attributes
Setup
Connecting your Braze account with Lexer requires the following information:
- Braze API Key and URL
- Braze Segment ID for all users
- Braze Segment ID for updated users
- AWS S3 Bucket (Lexer or self-hosted)
Braze API Key and URL
To connect Braze with Lexer, you'll need your Braze API Key and API URL. Follow these steps to retrieve them:
Obtain your Braze API Key:
- Log into your Braze dashboard
- Navigate to Settings > APIs and Identifiers
- Click "Create API Key" with name "Lexer Integration"
- IP Addresses property to be left disabled
- Check all of the permissions options
- Click "Create API Key"
- Find your API key Identifier and copy this value.
Find Your Braze API URL:
- Navigate to this Braze guide and reference their Endpoints table.
- For example, if you URL is "https://dashboard-01.braze.com" then your REST endpoint is "
https://rest.iad-01.braze.com"
Create Braze Segment for All Users
Lexer uses this Segment to perform a historical sync of your Braze profiles. Learn how to create segments in Braze.
Create a segment with the following details:
- Segment Name: "Lexer - All Users"
- Segment Description: "Segment created for Lexer integration"
- Apps and websites targeted: "Users from all apps"
- Segment Builder > Filter Group: Leave this blank to include all users
Once the segment is created you can find the Segment API Identifier at the bottom. Copy this value.
Create Braze Segment for Updated Users
Lexer uses this Segment to perform a daily sync of your recently updated Braze profiles. Learn how to create segments in Braze.
Create a segment with the following details:
- Segment Name: "Lexer - Updated Users"
- Segment Description: "Segment created for Lexer integration"
- Apps and websites targeted: "Users from all apps"
- Segment Builder > Filter Group: Apply the filters demonstrated in the screenshot below
Once the segment is created you can find the Segment API Identifier at the bottom. Copy this value.
AWS S3 Bucket
An AWS S3 bucket is required for Lexer to import data from Braze. Lexer manages an AWS S3 bucket for all customers, and we'll use this as the default, but you do have the option of supplying your own. If you prefer to self-manage an AWS S3 Bucket for this configuration, you can follow this AWS guide to get the required information.
AWS S3 Bucket Regions: Learn more about AWS S3 bucket regions here.
AWS S3 Bucket Path: The path should match the path you specified when connecting your S3 bucket to Braze (this can be blank if you did not specify anything in Braze).
Let's configure these details in Braze:
- On the left hand column, find the Integrations section and click Technology Partners.
- Scroll down and click AWS Cloud Storage.
- Enter the Access Key ID, Secret Access Key, and Bucket Name that you entered into Lexer. If you specified a Bucket Path in Lexer, you'll need to enter that here in Braze as well.
- Tick the "Make this the default data export destination" button.
- Once this is complete, press Test Credentials. If you notice any errors, please contact your Braze account manager.
- If you see no issues, remember to press Save. To make sure that's all done, refresh the page and see if the details you entered are still there.
Configuring your Braze account details in Lexer
Let's add your Braze details into Lexer to complete the setup process. In Lexer, navigate to Manage > Integrations and open the Braze integration and click Integrate Braze. Add the configuration details described below:
- Name: Add the name of your Braze account
- API URL: Add your REST endpoint URL
- API Key: Add your API key Identifier
- Braze Segment - All Customers: Add Segment API Identifier for "Lexer - All Users"
- Braze Segment - Customers Updated in 24H: Add Segment API Identifier for "Lexer - Updated Users"
- AWS S3 Bucket Authentication: If your S3 bucket is Lexer managed, we will provide information for each of these fields via email. If these are managed by you, refer to the link on 3. AWS S3 Bucket above to get the Name, Region, Path, Access Key ID, and Secret Access Key of your S3 bucket.
- Click Save Integration.
Syncing data from Lexer to Braze
Our Braze activation allows you to securely send your customer data from Lexer to Braze.
Before you get started, make sure you’ve done the following:
- Integrated your Braze account with Lexer by following all the steps above.
- Create your Lexer Segments that you wish to sync into Braze. If you need a refresher on creating Segments, read here.
Follow these steps to activate segments to Braze:
Okay I’ve sent my audience, what next?
The moment your activation has been confirmed as sent you’ll see records begin to update in Braze. Your Profiles won’t be fully updated in Braze until after you receive a confirmation email from Lexer advising that your activation is complete. Once you receive our email confirmation, you can now use these profiles as an audience in Braze!
When everything has arrived in Braze you’ll see your Audience Name, from the activation above, is now a Custom Attribute on Braze. Note that Braze can hold only 100 custom attributes, so be sure to keep on top of this. This article from Braze talks about this in detail. Let your Lexer Success Manager know as you get close to this limit.
Braze attributes sourced from Lexer
The activation permits you to send and update the following custom attributes in Braze.
Integration complete!
Congratulations! Your Braze account is now successfully integrated with Lexer. We’ve covered what Braze is, how the integration works, its benefits, and the step-by-step setup process. If you have any questions or need assistance, don’t hesitate to reach out to Lexer Support (support@lexer.io)—we’re here to help!