Onboarding

Braze 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. Go to Settings → Developer Console → API Keys

  2. Click Create New API Key

  3. Give it a name, e.g. EdgeTag

  4. Under Permissions, enable users.track

  5. Click Save API Key and copy the key

circle-info

The API key only requires the users.track permission. Do not grant broader permissions than needed.

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. Navigate to Channels and click Add Channel

  2. Search for Braze and select it

  3. Enter a name for this channel — choose something descriptive to help with debugging if issues arise

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.

Last updated

Was this helpful?