# 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="/files/EW1NFORs9aQMm5VW3MbQ" 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" ![](/files/obM3GXVliqpGLMXx3PLf)

<figure><img src="/files/wgWgxtRLravkSJcos6X4" 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="/files/9yYNOPnrs9VW0Abo4Yel" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/coOGKxT0ehilL2gRD2r9" 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.  ![](/files/obM3GXVliqpGLMXx3PLf)

   <figure><img src="/files/0V9oN4cWD82TWrvN9IeI" 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="/files/jMFa6y5v7Ly16QPyzoI7" 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;

![](/files/17um1tRFETu2SZu2z9zU) &#x20;

<figure><img src="/files/QWd7rCoFGrwYlLOYKswh" 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="/files/RHopOLOmmuPck0hU2reX" alt=""><figcaption></figcaption></figure>

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.freshpaint.io/integrations/destinations/apps/appboy/braze-quick-start-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.