Set up Currents

This page outlines and describes the generic process for integrating and configuring Braze Currents.

Troubleshooting

Cannot add a new Currents integration

If you see “You do not have any remaining Currents integrations” when adding a new integration, or if the button to add a new Currents connector is greyed out, common causes are:

• No Currents entitlement has been purchased for this workspace.
• The Currents entitlement is available in a different workspace in your company.

To resolve this, check other workspaces within your company. A different workspace may show an available Currents entitlement. If you need to request an entitlement or adjust your configuration, contact your Braze account manager.

Cannot enable additional event tracking

If you can create or edit a connector but can’t enable one of the optional tracking switches, your workspace may have reached an entitlement limit for that event category.

• Track Customer Behavior and User Events requires available Customer Behavior Events entitlements.
• Track user profiles and attributes requires available User Profiles and Attributes entitlements.

If you need additional entitlements or help adjusting your configuration, contact your Braze account manager.

Understanding integration error notifications

When a Currents integration has trouble delivering events, Braze emails the contact email addresses set on that integration. If the integration has no contact email, Braze asks your Braze account team to reach the right person. To get these notices directly, add a contact email to each integration.

Every notice uses the same subject line, “[Urgent Action Required to Prevent Data Loss] Company name Integration type Currents integration failing”, including notices that the integration has recovered. To identify which notice you received, find the matching phrase from the email body in the following table. If the email says that the integration was disabled, use the matching “disabled” row, even if the email also says the integration is still failing.

Phrase in the email	What it means	What to do
The integration “is failing due to invalid credentials” or “is still failing due to invalid credentials”	The destination rejected the credentials Braze uses to send data. The credentials may have expired or changed. The email includes the error and the approximate time the integration started failing.	Update the credentials on the integration in Braze. Braze starts dropping events after five days, and dropped events can’t be recovered.
The integration “is failing and receiving an unsupported response from the target endpoint” or “is still failing due to receiving unsupported responses”	The destination returned a response that Braze can’t process. Braze keeps retrying. The email includes an example response.	Confirm that your destination is set up correctly, and contact the destination’s support team with the response from the email. If the issue persists, Braze starts dropping events after five days.
The integration “is being rate-limited by the destination”	The destination is limiting how much traffic it accepts from Braze. Braze keeps retrying and sends events after the destination accepts traffic again.	Check that the rate limit on your endpoint can handle the volume Braze sends, or ask the destination’s support team for a higher throughput limit.
The integration “is failing with HTTP 400 Bad Request responses from the destination”	The destination is rejecting the payloads Braze sends. The email includes an approximate count of failed events.	For a custom HTTP connector, check whether your endpoint changed the request format it accepts. If the email says this is a known failure scenario for your connector, contact the destination’s support team.
“we have temporarily disabled it”	The integration hasn’t been able to send data since the time in the email, so Braze disabled it. Braze doesn’t queue new data while the integration is disabled, and keeps already queued data for up to seven days.	Fix the underlying issue (such as expired credentials) and re-enable the integration in Braze. You lose queued data if you don’t fix and re-enable the integration within seven days.
The integration “has been disabled”	The integration was disabled while it was failing, for example by a company user. Braze doesn’t queue new data until the integration is re-enabled, and keeps already queued data for up to seven days.	Re-enable the integration after fixing the underlying issue to send the queued data and new data.
The integration “is now recovering”	The issue is resolved and data is flowing again, but data is delayed while Braze sends the backlog. Braze sends a follow-up when it’s caught up.	No action needed.
The integration “has fully recovered”	Braze has caught up and sent all backlogged data.	No action needed.

Requirements

Using Currents with any of our partners requires the same basic parameters and connection methodology.

Each partner requires that Braze has permission to write and send data files to them, and Braze asks for the location they should write those files to, specifically bucket names or keys.

The following requirements are the basic, minimum requirements to integrate with most of our partners. Some partners will require additional parameters, which are listed in their respective partner documentation along with any nuances associated with these basic requirements.

Requirement	Origin	Access	Description
Account with partner	Arrange account with that partner or contact your Braze account manager for suggestions.	Check that partner’s site or contact that partner to sign up.	Braze will not send data to a partner if you don’t have access to that data through your company’s account.
Partner API Key or Token	Usually the partner’s dashboard.	Copy and paste it into the designated Braze field.	Braze has a designated field for this in the integrations page for that partner. We need this to map where we send your data. Keep your Partner Keys or Tokens up to date; invalid credentials may disable your connector and drop events.
Authentication Code/Key, Secret Key, Certification File	Contact a representative for your account with that partner. May also exist in the partner’s dashboard.	Copy and paste keys into the designated Braze field. Generate and upload .json or other certification files into the appropriate place in Braze.	Braze has a designated field for this in the integrations page for that partner. This gives Braze credentials and authorizes us to write files to your partner account. It’s important to keep your authentication details up to date; invalid credentials may result in disabling your connector, and dropping events.
Bucket, Folder Path	Some partners organize and sort data by buckets. This should be found in the partner’s dashboard.	If this is required, copy the bucket name or file path exactly into the designated space in Braze.	Though this is required for some partners, it’s important to get right when you do need it.

Setting up Currents

Step 1: Choose your partner

Braze Currents allows you to integrate through Data Storage using flat files or to our behavioral analytics and customer data partners using a batched JSON payloads to a designated endpoint.

Before you begin your integration, it’s best to decide which integration is best for your purposes. For example, if you already use mParticle and Segment and would like Braze data to stream there, it would be best to use a batched JSON payload. If you would prefer to manipulate the data on your own or have a more complex system of data analysis, it might be best to use Data Storage (Braze uses this method!)

Step 2: Open Currents

To get started, go to Partner Integrations > Currents. You’ll be taken to the Currents integration management page.

Step 3: Add your partner

Add a partner, sometimes called a “Currents connector,” by selecting the dropdown at the top of the screen.

Each partner requires a different set of configuration steps. To enable each integration, refer to our list of available partners and follow the instructions on their respective pages.

Provide a contact email for integration error notifications. Braze sends notifications to this address if the integration encounters errors, such as credential issues or connectivity problems. To help ensure the right people receive alerts, use a distribution list or group email address.

Step 4: Configure your events

Choose the events you wish to pass to that partner by checking from the available options. You can find listings of these events in our Customer Behavior Events and Message Engagement Events libraries.

If needed, you can learn more about our events in our event delivery semantics article.

Step 5: Set up field transformations

You can use Currents field transformations to remove or hash a string field.

• Remove: Replaces the string field with [REDACTED]. This is helpful if your partner rejects events with missing or empty fields.
• Hash: Applies an SHA-256 hashing algorithm to the string field.

Selecting a field for one of these transformations will apply that transformation to all events in which that field appears. For example, selecting email_address for hashing will hash the email_address field in Email Send, Email Open, Email Bounce, and Subscription Group State Change events.

Field transformations work only on string fields. Other field types, such as arrays, aren’t available to select, so you can’t remove or hash them. For example, the suspected_bot_click_reason array field in Email Click events stays in your export.

Edit field transformations on a live connector

You can add, change, or remove field transformations on a live connector without relaunching it. After you update the connector, your changes take effect in about 5 minutes.

Editing field transformations doesn’t change the Avro schema version or the version=<currents_version> segment in your storage path. Only Currents releases change that segment. For more information, see Avro schema changes.

Step 6: Test your integration

Before you test, consider checking out our sample Currents data in GitHub. When you’re ready to test, you choose an option in the following section:

Sending test events

To test your integration, you can select Send Test Events to send one event from each of your selected event types to this Current. For detailed information about each event type, refer to our Customer Behavior Events and Message Engagement Events libraries.

Testing Currents connectors

Test Currents connectors are free versions of our existing connectors that can be used for testing and trying out different destinations. Test Currents have:

• Up to 10 Test Currents connectors per workspace.
• An aggregate maximum of 1,500 events per fixed 24-hour period, resetting at midnight UTC. On the Currents page, you can track your current sending volume against this limit. Braze updates this total hourly.

Braze checks Test Currents usage against this limit once per hour. If a large burst of events arrives between two hourly checks, your Test Currents connectors can export more than 1,500 events in that period before the limit takes effect.

After an hourly check finds that your Test Currents connectors have reached the sending limit, Braze disables the connector and drops events that are created while the limit is reached. Event syncing resumes after the limit resets at midnight UTC.

To upgrade your Test Currents connector, edit the integration in the dashboard and select Upgrade Test Integration.

Updating Currents

To update your Currents connector after launching, do the following:

1. In Braze, navigate to Partner Integrations > Data Export.
2. Locate and your Currents connector in the list.
3. Select  Edit.
4. Make your changes.
5. Select Update Current.

This will not stop your existing export and will begin sending events according to your new selection.

IP allowlisting

Braze will send Currents data from the listed IPs:

• united states (us)
• european union (eu)
• australia (au)
• indonesia (id)
• japan (jp)
• south korea (kr)