# Braze Quick Start Guide

Braze is a customer engagement platform. You can send events to Braze to complement the engagement that they already track, allowing you to see a fuller picture of your users' behavior.

## Destination Info

* Accepts [Track](https://documentation.freshpaint.io/developer/freshpaint-sdk-reference#track) and [Identify](https://documentation.freshpaint.io/developer/freshpaint-sdk-reference#identify) calls
* Supports [HIPAA mode](https://documentation.freshpaint.io/hipaa-mode)
* Connection Modes:

<table><thead><tr><th width="158.33333333333331" align="right"> </th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>true</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

## Getting Started

1. Navigate to the Braze destination configuration:

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FqZjGWRbVILS9ECPZZqHh%2FAppboy.png?alt=media&#x26;token=99a3c1c0-d346-4a32-bfec-d94f6bb028fd" alt=""><figcaption></figcaption></figure>

2. **Configure your REST API Key**. If you don't have a REST API key, yet, you can create one by going to Settings > Developer Console and click "Create New API Key" ![](https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FiwvMhaRoOBMbwhkuYbTx%2FPasted%20Graphic%201.png?alt=media\&token=96b255c8-6f87-4044-9350-67bfa6583b71)

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FOeibbCjlxDpE2p8CjJXq%2FPasted%20Graphic%202.png?alt=media&#x26;token=ef140c49-0087-4927-817c-744b6c248a91" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Braze REST API keys are very powerful, and can be given permissions to do a wide variety of things with your account. **To protect yourself, it's critical that you limit the permissions of this key to only the `users.track` API call.** Use the screenshot below to see how this would look.
{% endhint %}

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FPBA71WmOuiEhTtXaWeNs%2Fimage.png?alt=media&#x26;token=02824ee4-7dbe-499f-83d7-37da95ebdb66" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FfhbV9fnLEqKRR08V009R%2FScreen%20Shot%202022-08-31%20at%201.21.15%20PM.png?alt=media&#x26;token=e3d5a06b-02ff-40f2-b7f7-43e3c8aa4044" alt=""><figcaption><p>You can create a REST API key on your Developer Console in Braze's app</p></figcaption></figure>

3. #### Configure your App Identifier

   When using the server-side connection mode, this identifier can be used to associate your events with a specific app that you've configured on your Braze account. For more information, please [click here](https://www.braze.com/docs/api/api_key/) to read Braze's REST API key overview. When in client-side connection mode, this will be used as the API key for client-side API requests.  ![](https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FiwvMhaRoOBMbwhkuYbTx%2FPasted%20Graphic%201.png?alt=media\&token=96b255c8-6f87-4044-9350-67bfa6583b71)

   <figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2F67uQlGMjtuzVWCQHsWFC%2Fimage.png?alt=media&#x26;token=5c700c2a-a9c8-441d-a951-4b5cada86ddd" alt=""><figcaption></figcaption></figure>
4. **Configure your Custom Endpoint.**&#x20;

{% hint style="info" %}
You must at least configure your API key and Custom Endpoint in order to connect to the Braze destination
{% endhint %}

Make sure you configure the REST endpoint, not the SDK endpoint. It should have the following format: <https://rest.iad-01.braze.com>. You can see the REST endpoints and corresponding SDK endpoints [here](https://www.braze.com/docs/api/basics/#api-definitions).

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2F7jrg7JehLUoHdCgW6gXt%2FScreen%20Shot%202022-08-31%20at%201.21.57%20PM.png?alt=media&#x26;token=f868f2a3-4cfb-40e7-a7b2-a112f6c9a5e6" alt=""><figcaption><p>You should assume you do have a custom endpoint - <a href="https://www.braze.com/docs/api/basics/#endpoints">read more here</a></p></figcaption></figure>

5\. That's it! You should now see the [enabled status](https://documentation.freshpaint.io/readme/setting-up-your-destinations/enabling-and-disabling-a-destination) next to the Braze destination. Enable the Braze destination for events you'd like to send to this destination in the event definition.

### In order to send events to Braze, enable the destination for each event

### &#x20;Confirm you are seeing events in Braze as expected

You can view visualizations of your events by going to Custom Events and searching for the event you'd like to view.&#x20;

![](https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2F0szfv70bno9jZE5tiHOF%2FPasted%20Graphic%205.png?alt=media\&token=b7dda704-d5b6-43ab-8355-964414a3c25e) &#x20;

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2FCbEJyedEReVMK7TOSYad%2FPasted%20Graphic%206.png?alt=media&#x26;token=293aec13-abbd-420d-bc3d-19da82e09ad1" alt=""><figcaption></figcaption></figure>

You can also see custom events associated with identified users when you look under the user's profile.

<figure><img src="https://1666823438-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA7aDqsXMFbUsWVqonF%2Fuploads%2F5kiYZBinGqVeRzJj75QW%2FAll%20Button%20Clicks.png?alt=media&#x26;token=ff0c02cf-9486-430a-a9ff-d7b5388a8fbf" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Braze does not deduplicate events out of the box.
{% endhint %}
