Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DI-6829] Correct field transformation documentation #8551

Merged
merged 3 commits into from
Dec 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ The following requirements are the basic, minimum requirements to integrate with
It's important to keep your Partner Keys/Tokens and authentication details up to date; if your connector's credentials expire, the connector will stop sending events. If this persists for more than **48 hours**, the connector's events will be dropped and data will be permanently lost.
{% endalert %}

## Step 1: Choose your partner
## 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 utilize 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]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/how_braze_uses_currents/)!)

## Step 2: Navigate to Currents
### Step 2: Open Currents

To get started, go to **Partner Integrations** > **Data Export**. You'll be taken to the Currents integration management page.

Expand All @@ -52,39 +54,43 @@ If you are using the [older navigation]({{site.baseurl}}/navigation), you can fi

![Currents page in the Braze dashboard]({% image_buster /assets/img_archive/currents-main-page.png %})

## Step 3: Add partner
### 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]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/available_partners/) and follow the instructions in their respective pages.

## Step 4: Configure events
### 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]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events/) and [Message Engagement Events]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events/) libraries.

![]({% image_buster /assets/img/current4.png %})

If needed, you can learn more about our events in our [event delivery semantics]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/event_delivery_semantics/) article.

## Step 5: Field transformations
### Step 5: Set up field transformations

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

Currents field transformations allow you to designate certain string fields in Currents for removal (replace with an empty string) or hashing (applying an SHA-256 hashing algorithm).
- **Remove:** Replaces the string field with `[REDACTED]`. This is helpful if your partner rejects events with missing or empty fields.
- **Hash:** Applys 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.

![Adding field transformations]({% image_buster /assets/img/current3.png %})

## Step 6: Test your integration
### Step 6: Test your integration

You may test your integration or take a look at the sample Currents data in our Currents examples [GitHub repository](https://github.com/Appboy/currents-examples).

{% alert important %}
Note that Currents will drop events with excessively large payloads of greater than 900 KB.
{% endalert %}

### Test Currents connectors
#### 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:

- No limit to the number of Test Currents connectors you may build.
- An aggregate maximum of 10,000 events per seven-day rolling period. This event total is updated hourly on the dashboard.

Expand Down Expand Up @@ -144,4 +150,4 @@ Braze will send Currents data from the listed IPs, which are automatically and d
| `40.76.166.81`
| `40.76.166.71`
| `40.76.166.144`
| `40.76.166.145`
| `40.76.166.145`