Braze Real-Time API-Triggered Campaign

Send an API-triggered Braze campaign to a single recipient as soon as Amperity sees the customer interaction that should trigger it, using the send triggered campaign messages endpoint. Each real-time point becomes one recipient. The same request can update that user’s Braze profile attributes and pass trigger properties to the campaign for personalization.

Use this connector when Amperity decides that the campaign should go out. For a campaign that Braze triggers itself, off a custom event or an attribute change, use the Braze Real-Time Action-Based Campaign connector instead. To send customer profile attributes on a schedule rather than in real time, use the Braze destination.

This connector sends from a real-time journey. See Real-time destinations.

Credentials

Name and description

The name and description for a credential.

API key

Required. The Braze REST API key for your account. The key must have the campaigns.trigger.send permission.

Create or find a REST API key in the Braze dashboard under Settings > API Keys. A REST API key is scoped to a single Braze instance, so the key must belong to the same instance you configure for this destination.

Settings

Name and description

The name and description for a destination.

Business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow limited access to PII for this destination.

Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.

Instance

Required. Select the Braze instance for your account. May be one of “US-01”, “US-02”, “US-03”, “US-04”, “US-05”, “US-06”, “US-07”, “US-08”, “EU-01”, “EU-02”, or “JP-01”.

Activate node settings

The rest of the configuration for this connector belongs to the journey that sends to it. Add this destination to an Activate node, then configure the following fields on that node. Two nodes may send to the same destination with different campaigns, identifiers, and attributes.

Campaign API identifier

Required. The API identifier of the campaign to trigger, found on that campaign’s Settings tab in Braze. The campaign must be an API-triggered campaign; Braze rejects a trigger request for any other campaign type.

The recipient must also meet the campaign’s audience, channel eligibility, and re-eligibility rules. If they don’t, Amperity reports the send as successful, but Braze sends nothing.

Braze user identifier

Required. The identifier Braze matches the recipient on. May be “external_user_id” or “email”. Braze accepts only one identifier per recipient, so this choice decides which one Amperity sends.

When several Braze profiles share an email address, Amperity asks Braze to prefer the profile that has an external ID, and then the most recently updated profile. If that still doesn’t narrow the match to one profile, Braze sends nothing.

Identifier attribute

The Amperity attribute that supplies the value for the identifier selected above. Required when the identifier is “email”; a send without it fails. When the identifier is “external_user_id”, leave this unset to send the Amperity profile ID.

Only send to users who already exist in Braze

Enabled by default, so that a customer Braze does not recognize is skipped. Clear this option only if you want Braze to create a new user profile for an unrecognized recipient.

Braze user attributes

Attributes written to the Braze user profile alongside the send. Braze sorts each name into one of its own standard profile fields or into a new custom attribute by exact, case-sensitive match, so “first_name” updates the standard field while “First_Name” creates a custom attribute. Braze identity fields, such as “external_id” and “braze_id”, cannot be set here; use the Identifier attribute field instead.

API trigger properties

Attributes sent as trigger properties for this send. Reference these in the campaign’s message body to personalize it. Trigger properties apply to a single send and are not stored on the Braze user profile.