Skip to main content

Authorization

Follow this guide to create a new Braze credential that will allow Nexla to authenticate to and exchange data with your Braze account.
braze_api_auth.png

Braze

Prerequisites​

Before creating a Braze credential, you need to obtain a REST API key from your Braze account and identify your Braze instance URL. The REST API key is required to authenticate with the Braze REST API, and the instance URL determines which Braze data center your account is provisioned to.

To obtain your REST API key, you need to have a Braze account with API access enabled. Once you have access to your account, you can find your REST API key in the Braze dashboard by navigating to the Developer Console section for each app group. The REST API key is used to authenticate all API requests to the Braze REST API using Bearer token authentication in the Authorization header.

To identify your Braze instance URL, you need to determine which Braze data center your account is provisioned to. Braze has multiple REST endpoints based on your instance location. Common instance URLs include:

  • https://rest.iad-01.braze.com (US East - Virginia)
  • https://rest.iad-02.braze.com (US East - Virginia 02)
  • https://rest.iad-03.braze.com (US East - Virginia 03)
  • https://rest.iad-04.braze.com (US East - Virginia 04)
  • https://rest.iad-06.braze.com (US East - Virginia 06)
  • https://rest.iad-08.braze.com (US East - Virginia 08)
  • https://rest.sfo-01.braze.com (US West - California)
  • https://rest.sfo-02.braze.com (US West - California 02)
  • https://rest.sfo-03.braze.com (US West - California 03)
  • https://rest.sfo-04.braze.com (US West - California 04)
  • https://rest.sfo-06.braze.com (US West - California 06)
  • https://rest.sfo-08.braze.com (US West - California 08)
  • https://rest.fra-01.braze.com (EU - Frankfurt)
  • https://rest.fra-02.braze.com (EU - Frankfurt 02)
  • https://rest.lon-01.braze.com (EU - London)
  • https://rest.lon-02.braze.com (EU - London 02)
  • https://rest.syd-01.braze.com (APAC - Sydney)
  • https://rest.syd-02.braze.com (APAC - Sydney 02)
  • https://rest.sgp-01.braze.com (APAC - Singapore)
  • https://rest.sgp-02.braze.com (APAC - Singapore 02)
  • https://rest.tok-01.braze.com (APAC - Tokyo)
  • https://rest.tok-02.braze.com (APAC - Tokyo 02)

You can find your instance URL in your Braze dashboard or by checking your Braze account settings. For detailed information about Braze API authentication, REST endpoints, and API key setup, refer to the Braze API documentation.

Create a Braze Credential​

  • To create a new Braze credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Braze

BrazeCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

REST API Configuration​

  1. Enter your Braze REST instance URL in the Rest Instance URL field. This should be the complete URL of your Braze REST endpoint, including the protocol (https://). Use the correct REST endpoint based on which instance you are provisioned to. The default value is https://rest.iad-01.braze.com if not specified.

    The instance URL must match your Braze account's data center location. Using an incorrect instance URL will result in authentication failures. You can find your instance URL in your Braze dashboard or account settings. For a complete list of Braze REST endpoints, see the Braze API documentation.

  2. Enter your Braze REST API key in the Rest API Key field. This is the REST API key you obtained from your Braze dashboard Developer Console. The REST API key is sent in the Authorization header as a Bearer token to authenticate all API requests to the Braze REST API.

    Keep your REST API key secure and do not share it publicly. The API key provides access to your Braze account and should be treated as a sensitive credential. The API key can be found within the Braze dashboard by navigating to the Developer Console section for each app group.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.