Skip to main content

Braze

The Braze source connector connects to the Braze REST API. At this time, the connector supports credential validation during setup, but data extraction is still in development.

Overview​

The Braze connector lets you connect to Braze’s REST API.

In addition to the Braze source, we also provide a Braze Audiences destination. This destination is currently in development: you can validate credentials during setup, but loading/syncing data is not yet supported.

Setup​

Before configuring the connector, you’ll need:

  • Your Braze REST API endpoint (your instance’s REST endpoint)
  • A Braze REST API Key with permission to access the REST API

Authentication​

This connector authenticates using a Bearer token (your Braze REST API Key) sent in the Authorization header.

During setup/login, the connector validates credentials by calling the Braze endpoint:

  • GET /campaigns/list?page=0&include_archived=false

The Braze API URL must be a valid HTTPS URL and use a braze.com host (for example, https://rest.iad-01.braze.com). If the URL is provided without a scheme, https:// is assumed.

If the validation request succeeds, the credentials are considered valid.

Configuration​

FieldTypeRequiredDescription
urlstring✅Your Braze REST API base URL. Must be HTTPS and hosted on braze.com (for example, https://rest.iad-01.braze.com). The connector will also accept a host without a scheme and will assume https://. Trailing slashes are ignored.
rest_api_keystring✅Your Braze REST API key used as a Bearer token for API requests.
  • Must be a valid URL
  • Must use HTTPS
  • Host must be braze.com or a subdomain of braze.com

Examples of valid values:

  • https://rest.iad-01.braze.com
  • rest.iad-01.braze.com (treated as https://rest.iad-01.braze.com)

Streams​

No streams are currently available. The connector’s extraction functionality is still in development, so it does not yet produce any tables/streams.