Braze
This page contains the setup guide and reference information for the Braze source connector.
Prerequisites
It is required to have an account on Braze to provide us with URL and Rest API Key during set up.
Rest API Keycould be found on Braze Dashboard -> Developer Console tab -> API Settings -> Rest API KeysURLcould be found on Braze Dashboard -> Manage Settings -> Settings tab ->Your App name-> SDK Endpoint
Set up the Braze connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, enter the name for the Braze connector and select Braze from the Source type dropdown.
- Fill in your
URL,Rest API KeyandStart dateand then click Set up source.
Supported sync modes
The Braze source connector supports the following sync modes:
- Full Refresh | Overwrite
- Incremental Sync | Append
Supported Streams
- 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
Performance considerations
Rate limits differ depending on stream.
Rate limits table: https://www.braze.com/docs/api/api_limits/#rate-limits-by-request-type
Reference
Config fields reference
Field
Type
Property name
string
url
string
api_key
string
start_date
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.3.0 | 2023-11-04 | 31857 | Add Campaigns, Canvases, Segments Details Streams |
| 0.2.0 | 2023-10-28 | 31607 | Fix CanvasAnalytics Stream Null Data for step_stats, variant_stats |
| 0.1.4 | 2023-11-03 | 20520 | Fix integration tests |
| 0.1.3 | 2022-12-15 | 20520 | The Braze connector born |