Braze

This connector captures data from Braze into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-braze:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources

The following data resources are supported through the Braze APIs:

• campaigns
• campaigns_analytics
• canvases
• canvases_analytics
• events
• events_analytics
• kpi_daily_new_users
• kpi_daily_active_users
• kpi_daily_app_uninstalls
• cards
• cards_analytics
• segments
• segments_analytics

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

It is required to have an account on Braze to provide us with URL and Rest API Key during set up.

• Rest API Key could be found on Braze Dashboard -> Developer Console tab -> API Settings -> Rest API Keys
• URL could be found on Braze Dashboard -> Manage Settings -> Settings tab -> Your App name -> SDK Endpoint

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Braze source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/api_key	Braze REST API Key	Braze API Key.	string	Required
/start_date	Start Date	Rows after this date will be synced.	string	Required
/url	URL	Braze REST API endpoint.	string	Required

Bindings

Property	Title	Description	Type	Required/Default
/stream	Stream	Resource of your Braze project from which collections are captured.	string	Required
/syncMode	Sync Mode	Connection method.	string	Required

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-braze:dev
        config:
          api_key: <key>
          start_date: 2017-01-25T00:00:00Z
          url: <url>
    bindings:
      - resource:
          stream: events
          syncMode: full_refresh
        target: ${PREFIX}/events
      {...}