Braze

Configuration guide for the Braze connector in Recurly Engage—API setup and supported user management actions.

Overview

Required plan

This feature or setting is available to all customers on any Recurly Engage subscription plan.

Prerequisites & limitations

  • Company or App Administrator permissions in Recurly Engage.
  • A Braze account with REST API access enabled (App Group REST API Key).
  • Ensure your Braze instance’s Base URL and API Key are available.

Definition

The Braze connector uses your Braze REST API credentials to add or update user records—mapping email addresses and optional aliases—when users interact with prompts.

Key benefits

  • Synchronized user profiles: Automatically enroll or update users in Braze for downstream messaging.
  • Personalized engagement: Use prompt events to trigger Braze campaigns and segmentation.
  • Centralized setup: Manage Braze credentials and actions within the Recurly Engage console.

Key details

Required settings

Under Settings → Connectors → Braze, provide:

  • Base URL: Your Braze REST API endpoint (e.g., https://rest.iad-01.braze.com).
  • API Key: Your App Group REST API Key (see Braze API Reference).

Supported actions

Use these actions within prompt configurations to manage Braze user profiles:

ActionDescriptionUser DependenciesAdditional InstructionsForm Inputs
Add a user with email addressAdds a user record with an email address and optional alias to BrazeNoneEnter the alias label in the prompt editorrequired

Attach this action to a prompt interaction (e.g., Accept) to automatically push the user’s email and alias to Braze when they engage with your message.