Before you start
Things you need to know:
You must have:
A Fresh Relevance account.
A Braze account.
Set up in Braze
Get your API key from the Braze developer console or from your Braze account administrator if you don't have console access.
βLearn more in Braze's API Overview.Find your Braze endpoint URL. For instance, if your dashboard URL is
https://dashboard-03.braze.com
, your endpoint URL ishttps://rest.iad-03.braze.com
.On Braze's campaign details page, find the campaign ID.
Create a Messaging channel in Fresh Relevance
In Fresh Relevance, expand the User menu, then go to Settings > Messaging Provider(s).
Under Set up a new channel, expand the Messaging providers drop-down menu and select Braze.
Select Next.
Configure the settings:
Setting | Description |
Channel Name | Name your channel for easy identification. |
API Key | Enter the API key for Fresh Relevance to authenticate Braze. |
Endpoint URL | Enter your Braze account's REST API endpoint. |
Campaign ID | Enter the campaign ID to use with Fresh Relevance. You can set distinct campaign IDs for individual triggers on the trigger settings page. |
Global New Contact Permission Behaviour | Set the default subscription status for new contacts in Braze as Subscribed, Unsubscribed, or Opted in. |
Global Contact Exists Permission Behaviour | Choose the default subscription status for existing contacts in Braze. Options include Subscribed, Unsubscribed, Opted in or Do nothing. |
Subscription Group ID | Optionally include a Braze subscription group ID. This updates the contact's subscription status in both the subscription group and globally. |
New Contact Permission Behaviour | Define the subscription group status for new contacts as Subscribed or Unsubscribed. |
Existing Contact Permission Behaviour | Set the subscription group status for existing contacts as Subscribed, Unsubscribed, or Do nothing. |
Set up field mapping
To include a personalized cart layout, in your campaign emails:
Map Fresh Relevance field to Braze trigger property:
Link thecart_html
field from Fresh Relevance to a corresponding trigger property in Braze.Merge cart layout in email template:
In your campaign email template, use the mapped trigger property to embed the cart layout.
Example
Include the following snippet in your email template to display the personalized cart layout:
Hello {{custom_attribute.${firstname}}} {{custom_attribute.${lastname}}}!
Did you forget something?
{{api_trigger_properties.${cart_html}}}
Learn more in Field mapping.
Create triggers in Fresh Relevance
Learn to create Fresh Relevance trigger programs in Set up trigger programs.
Send a test email or SMS
To ensure Fresh Relevance is working correctly after setup, follow these steps to send a test message:
Go to Content > Cart Layout and select Default Cart Layout.
Under the heading Send Test Message, expand the drop-down menu and select the message you want to test.
Enter an email address or phone number to send the test email to.
Select Send Test Message(s), and a popup message appears at the top of the screen, confirming that a test was sent.
The test email or SMS is delivered to the specified email address or phone number.