Setting Up Your Braze Connector

This article takes you through the process of setting up the Braze Connector.

Please note that this Connector is a paid product. For pricing information, please reach out to your Smartling Customer Success Manager.

Braze Multi-Language Support

Before you begin using the connector, ensure you have added your target languages under Braze’s Multi-Language Support settings.

In Braze, navigate to Settings > Manage Settings > Multi-Language Support. 
Here is where you can manage your list of locales. For more information, refer to the Braze documentation. You will need to refer to this list when completing the Smartling Language Configuration.

This is the top-level multi-language support setting in Braze. If you are translating a content type that has multi-language support, such as Canvas or Campaign emails, you will also need to select the appropriate target locales for each individual email. Detailed instructions on translating these content types can be found here.

Connecting Braze to Smartling

1. Log into Smartling.
2. Create a Braze Connector project type in your Smartling Account.
   • Ensure all required target languages are added to the project
3. From within this project, click Settings > Braze Settings
4. Click Connect to Braze
   
5. Insert your Braze API URL
   • E.g.: https://rest.iad-01.braze.com 

   • You need to use your Braze login URL to find API URL in the endpoints table.

6. Insert your Braze API Key
   • In Braze, go to the Developer Console and click Create New API Key 
     
   • API Key should have all permissions for Templates and Content Blocks 
     
     
     
   • API Key should also have the following permissions for Campaigns: 
     campaigns.list
campaigns.details
campaigns.translations.get
campaigns.translations.update
     

     

   • API Key should also have the following permissions for Canvas: 
     canvas.list
canvas.details
canvas.translations.get
canvas.translations.update
     
     
     Steps 7-9 below only apply to Content Blocks and Email Templates. Please note that Email Templates are different from Campaign or Canvas email messages. Content Blocks and Email Templates are found under the Templates & Media section in Braze.
     
7. Insert a Language Attribute:
   
   • This is the liquid variable or custom attribute that you use in your scripts. This attribute appears in code snippets, as referenced in our documentation for Translating Blocks.
   • For example, see the language attribute in bold in the following email code snippet:

     {% if {{custom_attribute.${preferred_language}}} == 'ENGLISH' %}
     This is an example code snippet for emails in Braze.
     {%else%}
     Fallback HELLO
     {%endif%}
     

8. Insert the Source Language of your script as a locale code
   • This is the locale code of the source language contained in single quotations in your scripts.
   • For example, see the language attribute in bold in the following email code snippet:

     {% if {{custom_attribute.${preferred_language}}} == 'ENGLISH' %}
     This is an example code snippet for emails in Braze.
     {%else%}
     Fallback HELLO
     {%endif%}

9. Choose how you want your translated emails delivered to Braze by the Connector:
   • One Email for All Languages: the Connector delivers all languages in the same email as the source.
   • One Email per Language: the Connector creates a new email for each language in Braze.
10. (Optional) Verify your credentials by clicking Test Connection
11. Click Save Connection

Tip: Your Braze account is now connected to Smartling.

Braze Connector Configuration

When you have successfully completed connecting Braze to Smartling, the Braze Settings page has the following configurations

• General
• Language Configuration

General

You can configure the behavior of the connector when updates are made to your previously translated content.

1. From within your Smartling Braze Project, click on Project Settings > Braze Settings.
2. Click the "Automation of Prior Requests for Translation" dropdown to select your desired behavior.
3. Click Save.

Automation of Prior Requests for Translation

This setting controls how you want Smartling to monitor changes to content that has already been translated in Smartling. Smartling will not detect net new content, only updates to content that have been submitted for translation in the past.

Options include:

• Automatically request translation (formerly "Auto"): The Braze Connector will detect changes to previously submitted source content every three hours. Any detected updates are batched into a Job and sit in awaiting authorization. However, if auto-authorize is enabled under Smartling Settings, the updated content is automatically authorized for translation. This feature does not detect content in new assets—only updates to content from assets previously submitted for translation. In other words, if an asset is brand new and has never been requested for translation, its content will not be picked up by this automation. See additional details here. 
• Flag changed content (formerly "Manual"): The Braze Connector will detect changes to source content every 3 hours, but will not automatically submit content changes for translation.
  • A user can manually select the changed assets that should be re-translated, and request translation from the Actions dropdown.
• Disabled (default and recommended): The Braze Connector will not detect changes to source content or automatically submit new changes.

3 hours is the recommended shortest time duration between checks. Talk to your Solutions Architect about changing the frequency to longer wave periods using cron.

Language Configuration 

In the Language Configuration section, you will see the number of target languages in your Smartling project. The first time you open this page, you will find a blank field to the left of each of the Smartling target languages. You must insert a name for each target language in each field and save to complete language mapping. 

Any language left blank will not appear in the dropdown list of target languages, when you request content for translation. 

Each time you add a new language to the project, you must map that language in the connector settings.

1. From within your Smartling Braze Project, click on Project Settings > Braze Settings.
2. Insert the Name of the language as it is listed in Braze under the Multi-Language Support setting. 
   
3. Click Save to save each mapping. 
   

Smartling Settings

Talk to your Customer Success Manager or Solutions Architect about options on auto-authorization, file retrievable formats, and file versioning.