API and SDK endpoints

Look up the correct dashboard URL, REST API endpoint, and SDK endpoint for your Braze instance. You need these URLs to log in, make API calls, and integrate the SDK.

Braze manages a number of different instances for our dashboard, SDK, and REST endpoints, which we call “clusters.” Your Braze onboarding manager will let you know which cluster you’re on. To learn more about the Braze SDK, check out the Braze 101 Braze Learning course.

Logging in at dashboard.braze.com automatically sends you to the correct cluster address.

important

When integrating your SDK, use the SDK endpoint. When making calls to our REST API, use the REST endpoint.

For details about accessing the API, see our API overview article.

Custom URLs

Instead of the standard SDK endpoint for your cluster, you can configure the Braze SDK to send its network requests to a custom URL, such as a proxy or a custom domain. The following SDKs support custom URLs:

• Braze Swift SDK: Version 11.8.0 and later
• Braze Android SDK: Version 2.11 and later

Configuring a custom URL

Set your custom URL where you set your SDK endpoint when you initialize the SDK. For the full integration steps, see Integrate the Braze SDK.

• swift
• android

1
2
3
4
5
6

let configuration = Braze.Configuration(
  apiKey: "YOUR_APP_IDENTIFIER_API_KEY",
  endpoint: "YOUR_CUSTOM_URL"
)
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze

1
2
3
4

BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"YOUR_APP_IDENTIFIER_API_KEY"
                                                                  endpoint:@"YOUR_CUSTOM_URL"];
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
AppDelegate.braze = braze;

1
2
3
4
5

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">YOUR_APP_IDENTIFIER_API_KEY</string>
  <string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_URL</string>
</resources>

1
2
3
4
5

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5

val brazeConfig = BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build()
Braze.configure(this, brazeConfig)

Testing your proxy configuration

Test that your proxy works as you expect before you release your app to production. To confirm that the SDK sends requests to your custom URL, use verbose logging:

1. Enable verbose logging in your development build before you initialize the SDK. For the code for each SDK, see Verbose logging.
2. Run your app on a test device or simulator. The SDK sends a request when a session starts.
3. In your logs, find the request entries and confirm the request URL matches your custom URL.
4. Confirm your proxy receives the requests from the SDK.

If you don’t see any requests to your custom URL on Android, verify your API key and endpoint configuration. For examples of what request entries look like in the logs, see Reading verbose logs.

important

Disable verbose logging before you release your app to production.