Braze API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "braze",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"gcs_folder": "your_gcs_folder",
"s3_export_bucket": "your_s3_bucket",
"gcs_export_bucket": "your_gcs_bucket",
"api_url": "test_api_url",
"gcs_bucket": "your_gcs_bucket",
"s3_export_role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
"abs_container_name": "your_abs_container_name",
"s3_export_folder": "your_s3_folder",
"s3folder": "your_s3_folder",
"abs_prefix": "your_abs_prefix",
"enable_exports": true,
"historic_sync_time_frame": "THREE_MONTHS | SIX_MONTHS | ONE_YEAR | TWO_YEARS | FIVE_YEARS | ALL_TIME",
"historical_sync_limit_date": "2006-01-01",
"historical_sync_limit": "ALL_TIME | DATE_LIMIT",
"cloud_storage_type": "AWS_S3 | GCS | AZURE_BLOB_STORAGE | NONE",
"export_storage_type": "AWS_S3 | GCS | AZURE_BLOB_STORAGE | NONE",
"s3role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
"abs_connection_string": "your_abs_connection_string",
"s3bucket": "your_s3_bucket",
"api_key": "test_api_key",
"gcs_export_folder": "your_gcs_folder",
"schema": "schema_name"
}
}
Config parameters
Name | Description |
---|---|
gcs_folder | Your GCS folder name. Required if GCS is the cloud_storage_type |
s3_export_bucket | Your S3 user export bucket. Required if AWS_S3 is the export_storage_type |
gcs_export_bucket | Your GCS bucket. Required if GCS is the export_storage_type |
api_url | Your Braze API URL. |
gcs_bucket | Your GCS bucket. Required if GCS is the cloud_storage_type |
s3_export_role_arn | The Role ARN required for authentication required if AWS_S3 is the export_storage_type |
abs_container_name | Container Name |
s3_export_folder | Your S3 user export folder name. Required if AWS_S3 is the export_storage_type |
s3folder | Your S3 folder name required if AWS_S3 is the cloud_storage_type |
abs_prefix | Prefix |
enable_exports | Enable User Profile Exports |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. |
historical_sync_limit_date | The start date (in YYYY-MM-DD) from which to sync historical data. Only used when historicalSyncLimit is set to DATE_LIMIT . |
historical_sync_limit | Range of data in history you would like to include in the initial sync. Valid values are ALL_TIME and DATE_LIMIT |
cloud_storage_type | Cloud storage type Braze Current is connected to. |
export_storage_type | Export Storage. Required if enable_exports is true |
s3role_arn | The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type |
abs_connection_string | Connection String |
s3bucket | Your S3 bucket required if AWS_S3 is the cloud_storage_type |
api_key | Your Braze API Key. |
gcs_export_folder | Your GCS folder name. Required if GCS is the export_storage_type |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are seven ways to authorize this connector type:
AWS S3 Current: By specifying the
cloud_storage_type
as"AWS_S3"
and the values for theapi_url
,api_key
,enable_exports
,s3bucket
,s3role_arn
ands3folder
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "enable_exports": true, "s3bucket": "your_s3_bucket", "s3role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket", "s3folder": "your_s3_folder", "cloud_storage_type": "AWS_S3" } }
GCS Current: By specifying the
cloud_storage_type
as"GCS"
and the values for theapi_url
,api_key
,enable_exports
,gcs_bucket
andgcs_folder
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "enable_exports": true, "gcs_bucket": "your_gcs_bucket", "gcs_folder": "your_gcs_folder", "cloud_storage_type": "GCS" } }
Azure Blob Storage Current: By specifying the
cloud_storage_type
as"AZURE_BLOB_STORAGE"
and the values for theapi_url
,api_key
,enable_exports
,abs_connection_string
,abs_container_name
andabs_prefix
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "enable_exports": true, "abs_connection_string": "your_abs_connection_string", "abs_container_name": "your_abs_container_name", "abs_prefix": "your_abs_prefix", "cloud_storage_type": "AZURE_BLOB_STORAGE" } }
User Export with Default Braze Public URL: By specifying the
cloud_storage_type
as"NONE"
, theenable_exports
as"true"
and theexport_storage_type
as"NONE"
and the values for theapi_url
andapi_key
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "enable_exports": true, "cloud_storage_type": "NONE", "export_storage_type": "NONE" } }
User Export with AWS S3: By specifying the
enable_exports
as"true"
and theexport_storage_type
as"AWS_S3"
and the values for theapi_url
,api_key
,s3_export_bucket
,s3_export_role_arn
ands3_export_folder
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "s3_export_bucket": "your_s3_bucket", "s3_export_role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket", "s3_export_folder": "your_s3_folder", "enable_exports": true, "export_storage_type": "AWS_S3" } }
User Export with GCS: By specifying the
enable_exports
as"true"
and theexport_storage_type
as"GCS"
and the values for theapi_url
,api_key
,gcs_export_bucket
andgcs_export_folder
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "braze", "group_id": "group_id", "config": { "api_url": "test_api_url", "api_key": "test_api_key", "gcs_export_bucket": "your_gcs_bucket", "gcs_export_folder": "your_gcs_folder", "enable_exports": true, "export_storage_type": "GCS" } }
By using the Connect Card or the Fivetran dashboard.