Braze
With Braze modules in Boost.space Integrator, you can manage the users, catalogs, catalog items, and messages in your Braze account.
To use the Braze modules, you must have a paid account. For subscription information, contact Braze directly. You can create a free 14-days trial account at try.braze.com.
Refer to the Braze API documentation for a list of available endpoints.
Connect Braze to Boost.space Integrator
To establish the connection, you must:
Obtain your API key in Braze
To obtain your API key from your Braze account:
-
Log in to your Braze account.
-
In the left sidebar, click Settings > APIs and Identifiers.
-
Click Create API Key.
-
In the API key name field, enter the name for the API key.
-
Optional: In the IP Addresses field, enter IP addresses that you want to allow list.
-
Under Permissions, select all the permissions.
-
Click Create API Key.
-
In the Identifier column, copy the API key value shown and store it in a safe place.
You will use this value in the API Key field in Boost.space Integrator.
Establish the connection with Braze in Boost.space Integrator
To establish the connection in Boost.space Integrator:
-
Log in to your Boost.space Integrator account, add a Braze module to your scenario, and click Create a connection.
-
Optional: In the Connection name field, enter a name for the connection.
-
In the Braze Instance field, select the instance where your Braze account is located.
-
In the API Key field, enter the API key copied above.
-
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more Braze modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
Build Braze Scenarios
After connecting the app, you can perform the following actions:
Users
Create or update a user profile
Creates or updates attributes, events or purchases for a user profile given its Braze ID, external ID or user alias.
Connection
Establish a connection to your Braze account.
Action
Select the action that you want to perform in this module.
Update Existing Profiles Only
Select whether you want to update profiles or create new ones.
Braze ID
Enter a user ID in your Braze account.
If you have a use ID in your Braze account, you may not specify a user external ID, user alias, email, or phone number.
External ID
Enter an external user ID.
If you have an external user ID, you may not specify a user Braze ID, user alias, email, or phone number.
User Alias
Enter a user alias label and name.
If you have a user alias, you may not specify a user Braze ID, user external ID, email, or phone number.
Enter a user’s email.
If you have a user’s email, you may not specify a user Braze ID, user external ID, user alias, or phone number.
Phone
Enter a user’s phone number.
If you have a user’s phone number, you may not specify a user Braze ID, user external ID, user alias, or email.
User attributes
Enter desired values to the user attributes fields.
Custom Attributes View
Select the attributes view to define custom attributes. The Simplified View shows all the attributes as they are in your Braze account. The Advanced View uses a JSON string.
Custom attributes
Enter desired values to the custom attributes fields. Displayed fields are automatically loaded from your Braze account.
Event attributes
Enter desired values to the event attributes fields.
Purchase attributes
Enter desired values to the purchase attributes fields.
Catalogs
List catalogs
Gets a list of all catalogs.
Connection
Establish a connection to your Braze account.
Limit
Set the Maximum number of results Boost.space Integrator will return during one execution cycle.
Create a catalog
Creates a new catalog.
Connection
Establish a connection to your Braze account.
Catalog Name
Enter the name for a new catalog.
Catalog Description
Enter the description for a new catalog.
Item Fields
Enter or map the following information:
Name
Enter the name for an item.
Type
Select or map the type of an item.
Delete a catalog
Deletes a catalog given its name.
Connection
Establish a connection to your Braze account.
Catalog Name
Enter or map the name of the catalog that you want to delete.
Catalog Items
List catalog items
Gets a list of items inside a given catalog.
Connection
Establish a connection to your Braze account.
Catalog Name
Enter or map the name of the catalog which items you want to list.
Limit
Set the Maximum number of teams Boost.space Integrator will return during one execution cycle.
Get a catalog item
Gets a catalog item given its ID.
Connection
Establish a connection to your Braze account.
Catalog Name
Enter or map the name of the catalog which item you want to get.
Item ID
Enter or map the ID of the item that you want to get.
Create or update a catalog item
Creates or updates a catalog item given its ID.
Connection
Establish a connection to your Braze account.
Action
Select the action that you want to perform in this module.
Catalog Name
Enter or map the name of the catalog where you want to create or update an item.
Item ID
Enter the name for a new catalog or a catalog that you want to update.
Item details
Enter desired values to the item fields. Displayed fields are automatically loaded from your Braze account.
Delete a catalog item
Deletes a catalog item given its ID.
Connection
Establish a connection to your Braze account.
Catalog Name
Enter or map the name of the catalog which item you want to delete.
Item ID
Enter or map the name of the item that you want to delete.
Messages
Send a campaign message
Sends a message from a given campaign.
Connection
Establish a connection to your Braze account.
Campaign ID
Enter the ID of the campaign from which you want to send a message.
Refer to Braze API documentation to learn how to find a campaign ID.
Send ID
Enter the send ID.
Refer to Braze API documentation to learn how to find a send ID.
Broadcast
Select if you want to send a message to an entire segment that a campaign targets.
If broadcast is set to true, you cannot include a recipients list.
Recipients
Enter or map the following information:
External User ID
Enter an external user ID.
If you have an external user ID, you may not specify a user alias or email.
User Alias
Enter a user alias label and name.
If you have a user alias, you may not specify an external user ID or email.
Enter a user email.
If you have a user email, you may not specify an external user ID or user alias.
Prioritization
Select or map an option for prioritizing the most recently updated user.
Refer to Braze API documentation to learn more.
Trigger Properties View
Select or map the trigger properties view to define trigger properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string.
Refer to Braze API documentation to learn more.
Trigger Properties
Enter a key and value for each trigger property.
Refer to Braze API documentation to learn more.
Send to existing only
Select or map whether you want to send a message to existing recipients only.
If you set it as no, you cannot use a user alias, and you must use custom attributes.
Custom Attributes View
Select or map the attributes view to define custom attributes. The Simplified View shows all the attributes as they are in your Braze account. The Advanced View uses a JSON string.
Custom Attributes
Enter desired values to the custom attributes fields. Displayed fields are automatically loaded from your Braze account.
Audience Select View
Select the audience select view to customize messages. The Simplified View allows setting up a filter with the and and or rules. The Advanced View uses a JSON string.
Refer to Braze API documentation to learn more.
Audience
Set up a filter for audiences using operators.
Refer to Braze API documentation to learn more.
Trigger Properties View
Select the trigger properties view to define trigger properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string.
Refer to Braze API documentation to learn more.
Trigger Properties
Enter a key and value for each trigger property.
Refer to Braze API documentation to learn more.
Attachments
Enter the following information:
File Name
Enter a name for the file. For example, image.jpg.
URL
Enter the URL of the file you want to attach to your message.
Send a canvas message
Sends a message from a given canvas.
Connection
Establish a connection to your Braze account.
Canvas ID
Enter the ID of the canvas from which you want to send a message.
Refer to Braze API documentation to learn how to find a canvas ID.
Broadcast
Select if you want to send a message to an entire segment that a canvas targets.
If broadcast is set to true, you cannot include a recipients list.
Recipients
Enter the following information:
External User ID
Enter an external user ID.
If you have an external user ID, you may not specify a user alias or email.
User Alias
Enter a user alias label and name.
If you have a user alias, you may not specify an external user ID or email.
Enter a user email.
If you have a user email, you may not specify an external user ID or user alias.
Prioritization
Select or map an option for prioritizing the most recently updated user.
Refer to Braze API documentation to learn more.
Canvas Properties Entries View
Select or map the canvas properties entries view to define canvas entry properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string.
Refer to Braze API documentation to learn more.
Canvas Entry Properties
Enter a key and value for each canvas entry property.
Refer to Braze API documentation to learn more.
Send to existing only
Select or map whether you want to send a message to existing recipients only.
If you set it as no, you cannot use a user alias, and you must use custom attributes.
Custom Attributes View
Select or map the attributes view to define custom attributes. The Simplified View shows all the attributes as they are in your Braze account. The Advanced View uses a JSON string.
Custom Attributes
Enter desired values of the custom attributes fields. Displayed fields are automatically loaded from your Braze account.
Audience Select View
Select the audience select view to customize messages. The Simplified View allows setting up a filter with the and and or rules. The Advanced View uses a JSON string.
Audience
Set up a filter for audiences using operators.
Refer to Braze API documentation to learn more.
Canvas Entry Properties View
Select the canvas properties entries view to define canvas entry properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string.
Refer to Braze API documentation to learn more.
Canvas Entry Properties
Enter a key and value for each canvas entry property.
Refer to Braze API documentation to learn more.
Other
Make an API call
Performs an arbitrary authorized API call.
Connection
Establish a connection to your Braze account.
URL
Enter a path relative to https://rest.iad-03.braze.com/. For example: /preference_center/v1/list.
Method
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/braze/).
