Braze templates CLI

Simple CLI tool written in Deno for creating a back-up of Braze templates and content blocks.

Config

In order to run backup and update commands you need to have a config file config.json defined in the same directory as binary. See config-example.json file for more info.

Important notes

• API tokens need to have permissions set in Braze in order to perform CRUD operations on emails and content blocks.
• Config file contains a production flag to differentiate the environment (sandbox and production)
• API tokens are not shared between sandbox and production, so you need to have a proper one defined along with a flag

Usage

• Build application for platform of your choice (supported: macOS x64, Linux x64)
• Move binary (email-templates) to the folder where your backup should be stored,
• Prepare config file (config.json) according to the example provided and put it in the same directory as binary. See config for more details
• Run command. See Command description

Commands

Description

Backup media type from Braze

Command usage:

./email-templates backup [type] {Options}

Arguments:

• type Media type, possible values: templates, content-blocks

Options:

• -h --help Help Screen
• -l, --list-only Backup only list of objects and save as map
• -i, --id Backup only a specific id

When no flag is provided, CLI will download list of available media types, saves it as a map and then back-ups all items of given type

Directories

Emails and content blocks data are stored in backup directory divided by environment (sandbox templates or production), it's media type (templates, content-blocks). Templates back up is divided into subject and body directories.

Each item is stored in HTML file with its name defined in Braze as a filename. If template or content block name defined in Braze contains a slash (/) it'll be replaced with a dash in the filename.

For emails templates body and subject HTML files are named the same.

Development

Install Deno (v1.8.0):

• Deno installation guide

Commands

deno run --allow-read --allow-net --allow-write main.ts backup [mediaType] [--list-only] [--id <id>]

Flags for main command backup are described in the Usage section. Flags --allow-read --allow-net --allow-write for deno run are required for CLI to access file system and network.

Compile binary

You can compile application locally using:

deno compile -o ./email-templates --target x86_64-apple-darwin --unstable --allow-read --allow-net --allow-write ./main.ts

Towards financial services available to all

We’re working throughout the company to create faster, cheaper, and more available financial services all over the world, and here are some of the techniques that we’re utilizing. There’s still a long way ahead of us, and if you’d like to be part of that journey, check out our careers page.