Skip to main content
Admin or developer permissions required to create and view API keys.

​
Generating a REST API key

A REST API key authenticates requests to Braze and requires explicit endpoint permissions.

1

Sign in to Braze

Sign in to your Braze dashboard.

  • Navigate to Settings > APIs and Identifiers.
  • Scroll to the REST API Keys section.
2

Create new API key

Click Create New API Key.

  • API Key Name: StackOne Integration
  • In the Permissions section, select the endpoints you want to access.
  • Minimum recommended permissions: campaigns.list, canvas.list, users.track, users.export.ids
  • Click Save API Key.
3

Copy the API key

Copy the generated API key immediately and store it securely for use later.

  • The key is visible after creation and can be viewed again in Settings.
  • Format: c1234567-89ab-cdef-0123-456789abcdef

​
Find your REST instance URL

Your REST instance URL identifies your Braze data center location.

1

Locate instance information

In the same Settings > APIs and Identifiers page.

  • Look for the REST Endpoint section at the top of the page.
  • Copy your instance’s REST endpoint URL.
  • Format: https://rest.{instance}.braze.com or https://rest.{instance}.braze.eu
  • Example US instance: https://rest.iad-01.braze.com
  • Example EU instance: https://rest.fra-01.braze.eu

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • REST API Key
  • REST Instance URL
  • App API Key
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.