> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/channels/braze/onboarding.md).

# Onboarding

## Onboarding

The Braze integration connects to EdgeTag using a REST API key. This guide walks you through creating the key in Braze and activating the channel in EdgeTag.

## Video Guide

#### Step 1: Create a REST API Key in Braze

1. Log in to your [Braze Dashboard](https://dashboard.braze.com)
2. Go to **Settings → Developer Console → API Keys**
3. Click **Create New API Key**
4. Give it a name, e.g. `EdgeTag`
5. Under **Permissions**, enable `users.track`
6. Click **Save API Key** and copy the key

{% hint style="info" %}
The API key only requires the `users.track` permission. Do not grant broader permissions than needed.
{% endhint %}

#### Step 2: Find Your REST Endpoint

Your REST endpoint is specific to the Braze cluster your account is hosted on.

1. In Braze, go to **Settings → Developer Console**
2. Copy the **REST Endpoint** shown at the top of the page — it looks like `https://rest.iad-01.braze.com`

| Cluster | REST Endpoint                   |
| ------- | ------------------------------- |
| US-01   | `https://rest.iad-01.braze.com` |
| US-02   | `https://rest.iad-02.braze.com` |
| US-03   | `https://rest.iad-03.braze.com` |
| US-04   | `https://rest.iad-04.braze.com` |
| US-05   | `https://rest.iad-05.braze.com` |
| US-06   | `https://rest.iad-06.braze.com` |
| US-08   | `https://rest.iad-08.braze.com` |
| EU-01   | `https://rest.fra-01.braze.eu`  |
| EU-02   | `https://rest.fra-02.braze.eu`  |

#### Step 3: Add the Channel in EdgeTag

1. Log in to your [EdgeTag Dashboard](https://app.edgetag.io)
2. Navigate to **Channels** and click **Add Channel**
3. Search for **Braze** and select it
4. Enter a name for this channel — choose something descriptive to help with debugging if issues arise

<figure><img src="/files/4vLTeuziXfMiOpqZofk7" alt=""><figcaption></figcaption></figure>

#### Step 4: Enter Your Credentials

Fill in the two required fields:

| Field             | Value                                            |
| ----------------- | ------------------------------------------------ |
| **API Key**       | The REST API key from Step 1                     |
| **REST Endpoint** | The endpoint URL from Step 2 — no trailing slash |

Click **Save & Deploy**

Congratulations, the basic setup is now complete. Let's proceed to the next section to explore additional configuration options.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.edgetag.io/channels/braze/onboarding.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.