Braze Quick Start Guide
Last updated
Last updated
Braze is a customer engagement platform. You can send events to Braze to complement the engagement that they already track, allowing you to see a fuller picture of your users' behavior.
Supports HIPAA mode
Connection Modes:
| Client-side | Server-side | |
|---|---|---|
Web | ||
Mobile | ||
Server |
Braze REST API keys are very powerful, and can be given permissions to do a wide variety of things with your account. To protect yourself, it's critical that you limit the permissions of this key to only the users.track API call. Use the screenshot below to see how this would look.
Configure your Custom Endpoint.
You must at least configure your API key and Custom Endpoint in order to connect to the Braze destination
Make sure you configure the REST endpoint, not the SDK endpoint. It should have the following format: https://rest.iad-01.braze.com. You can see the REST endpoints and corresponding SDK endpoints here.
5. That's it! You should now see the enabled status next to the Braze destination. Enable the Braze destination for events you'd like to send to this destination in the event definition.
You can view visualizations of your events by going to Custom Events and searching for the event you'd like to view.
You can also see custom events associated with identified users when you look under the user's profile.
Braze does not deduplicate events out of the box.
Configure your REST API Key. If you don't have a REST API key, yet, you can create one by going to Settings > Developer Console and click "Create New API Key"
When using the server-side connection mode, this identifier can be used to associate your events with a specific app that you've configured on your Braze account. For more information, please click here to read Braze's REST API key overview. When in client-side connection mode, this will be used as the API key for client-side API requests.
