Provider guides
Braze
What’s supported
Supported actions
This connector supports:- Read Actions, including full historic backfill and incremental read for
contactsonly. - Write Actions.
- Proxy Actions, using the base URL
https://rest.{{.restInstanceId}}.braze.com.
Supported Objects
The Braze connector supports reading from the following objects:- catalogs
- cdi/integrations
- email/hard_bounces
- email/unsubscribes
- campaigns
- canvas
- events/list
- events
- purchases/product_list
- segments
- custom_attributes
- messages/scheduled_broadcasts
- preference_center/v1/list
- sms/invalid_phone_numbers
- content_blocks/list
- templates/email/list
- catalogs
- email/status
- email/bounce/remove
- email/spam/remove
- email/blocklist
- users/export/ids
- users/export/segment
- users/export/global_control_group
- campaigns/duplicate
- canvas/duplicate
- messages/schedule/create
- campaigns/trigger/schedule/create
- canvas/trigger/schedule/create
- messages/schedule/update
- campaigns/trigger/schedule/update
- canvas/trigger/schedule/update
- sends/id/create
- messages/send
- campaigns/trigger/send
- canvas/trigger/send
- preference_center/v1
- scim/v2/Users
- sms/invalid_phone_numbers/remove
- subscription/status/set
- v2/subscription/status/set
- content_blocks/create
- content_blocks/update
- templates/email/create
- templates/email/update
- campaigns/translations
- canvas/translations
- templates/email/translations
- users/alias/new
- users/alias/update
- users/identify
- users/track
- users/track/sync
- users/delete
- users/merge
- users/external_ids/rename
- users/external_ids/remove
Example integration
For an example manifest file of a Braze integration, visit our samples repo on Github.Before You Get Started
Creating an API key for Braze
Click here for more information about generating an API key for Braze. The UI components will display this link, so that your users can successfully create API keys. The Rest Instance ID can also be found on the same page.
Using the connector
This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. Provider apps are only required for providers that use OAuth2 Authorization Code grant type. To start integrating with Braze:- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.