Skip to content
English
Contact us
Go to dataships.io
  • There are no suggestions because the search field is empty.

Connecting & configuring Braze

Connect Braze with an API key and start syncing consented subscribers automatically.

Connecting Braze to Dataships lets you sync consented email subscribers straight onto your Braze user profiles, with their consent status attached. Every shopper who opts in through your Dataships widget lands in Braze ready to receive your campaigns.

Setting up Braze takes three things: an API key, your REST endpoint, and one campaign built inside Braze so we hear about unsubscribes. The last part sounds more involved than it is — Braze has no way for us to register a webhook on your behalf, so you create a small campaign that sends subscription changes back to us. We give you instructions you can paste into BrazeAI Operator, which does the building for you.

Finding the Braze integration

In Dataships, go to Integrations → Marketing Platforms. Find the Braze card and click Install to open the Braze Configuration screen.

Step 1: Create your API key in Braze

Braze API keys cannot be edited after they are created, so tick every permission listed below. If you miss one you will need to create a new key.

  1. In Braze, go to Settings → APIs and Identifiers → API Keys.
  2. Click Create API Key and name it Dataships.
  3. Under Permissions, tick every permission in these four groups:
    • User data: users.track, users.export.ids, users.export.segment, users.delete
    • Email: email.unsubscribe, email.hard_bounces, email.status
    • Analytics: campaigns.list, segments.list, purchases.revenue_series, purchases.quantity_series
    • SMS and WhatsApp: subscription.status.get, subscription.status.set, subscription.groups.get, sms.invalid_phone_numbers, sms.invalid_phone_numbers.remove
  4. Click Save API Key and copy the key. Braze shows it once.
  5. Copy the REST endpoint from the same tab. It looks like https://rest.iad-03.braze.com and is specific to your Braze instance.

Why the SMS and WhatsApp permissions? Dataships supports email on Braze today. Because Braze keys cannot be changed later, taking these now saves you creating a second key if you add other channels.

Step 2: Connect in Dataships

On the Braze Configuration screen you will see an Authentication section with two fields.

  1. Paste your REST endpoint into the REST Endpoint field.
  2. Paste your API Key into the API Key field.
  3. Click Submit.

Once saved, the key is masked and the Authentication section shows as enabled. We treat your Braze API key like a password and store it encrypted.

Step 3: Set up the subscription change webhook

This step lets Dataships hear about unsubscribes that happen inside Braze, so your consent records stay accurate.

Under Braze Email Settings you will see a Subscription Change Webhook section with two options. You only need to complete one of them. Your webhook URL and account token are already filled in on both.

Option 1: Build it with BrazeAI Operator (recommended)
Follow the instructions as per the Control Panel.
Option 2: Set it up by hand

Follow the instructions as per the Control Panel. Use this if Operator is not available on your account.

Step 4: Activate your email channel

Back on the Configuration screen, if your email channel still needs activating you will see an Email Configuration section.

  • If the button reads Onboard with Email, click it and confirm in the modal to begin onboarding for your email channel.
  • If the button reads Go-live with Email, click it and confirm in the modal to activate your Braze email integration.

If neither button is visible, your email channel is already active and there is nothing to do.

During onboarding

If you are going through the Dataships onboarding flow for the first time, you will see a progress bar at the bottom of each screen. Click Next on the Authentication screen once you have connected Braze, and again on the Configuration screen once your channel is active.

What Dataships adds to your Braze profiles

Braze does not use lists, so Dataships writes directly to the user profile. Alongside the subscription state, we add two custom attributes you can use for segmentation:

Attribute What it holds
dataships_source Marks the profile as one Dataships has synced
dataships_email_consented_at The date and time Dataships captured consent

Braze records its own subscription timestamp when the state changes and does not allow it to be backdated, so dataships_email_consented_at is where your original consent date is kept.

Uninstalling Braze

To disconnect Braze, go to Integrations → Marketing Platforms and find the Braze card. Click the trash icon and confirm by clicking Uninstall in the modal. You can click Keep installed if you opened the modal by mistake.

Note: Uninstalling stops Dataships from syncing any new contacts to Braze. Your existing Braze profiles are not affected and nothing is deleted. If you uninstall, you may also want to pause the subscription change campaign in Braze.

FAQ

Does Dataships support SMS or WhatsApp on Braze?

Not at the moment. The Braze integration covers email. Braze supports SMS and WhatsApp as a platform, and the API key you create already carries the permissions needed, so no change is required on your side if support is added later.

Why do I need to create a campaign in Braze?

Braze has no API for registering a webhook. In Braze, a webhook is a type of campaign message, so the only way for us to receive subscription changes is a campaign in your account that sends them to us. It takes a few minutes to set up once, and Operator can build it for you.

Do I need to create lists or segments in Braze?

No. Braze keeps subscription status on the user profile rather than in lists, so there is nothing to configure in Dataships.

Where do I find my REST endpoint?

On the same Braze screen as your API key, under Settings → APIs and Identifiers → API Keys. It is specific to your Braze instance and looks like https://rest.iad-03.braze.com.

My unsubscribes are not reaching Dataships. What should I check?

Check these in order: that the campaign is launched rather than saved as a draft; that re-eligibility under Delivery Controls is set to 1 minute; and that the four body properties match exactly, including the Liquid tags.

Braze will not let me launch the campaign.

Braze requires at least one conversion event on a campaign that has a control group. Under Conversion Events, add Starts Session.

I missed a permission on my API key. Can I edit it?

No, Braze API keys are fixed once created. Create a new key with all the permissions listed in Step 1, then paste it into Dataships again.

What happens to my Braze profiles if I uninstall?

Nothing is deleted. Uninstalling only stops future syncing, and your existing profiles stay exactly as they are. You can reconnect at any time by clicking Install on the Braze card.