Braze Real-Time Action-Based Campaign

Log a custom event and update user profile attributes in Braze as soon as Amperity sees the customer interaction, using the track users endpoint. Braze owns the send: configure an action-based campaign or Canvas in the Braze dashboard that is entered by the event Amperity logs, or by a change to one of the attributes Amperity writes.

Use this connector when Braze should decide whether the customer is messaged. If Amperity should trigger the campaign directly, use the Braze Real-Time API-Triggered 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 users.track permission. With the optional events.list permission, the Event name field on an Activate node suggests the event names that already exist in Braze; without it, enter the name by hand.

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 event names, identifiers, and attributes.

Event name

Required. The name of the custom event logged in Braze. Use this name as the trigger for an action-based campaign or Canvas in the Braze dashboard. Braze creates a custom event the first time it receives one, so the name here and the name the campaign listens for must match exactly. If no campaign or Canvas is triggered by the event, Amperity reports the send as successful, but Braze sends nothing.

Event properties

Attributes sent as properties of the custom event. Reference these in the campaign’s message body to personalize it, or use them in the campaign’s entry criteria. Event properties belong to a single event and are not stored on the Braze user profile.

Braze user identifier

Required. The identifier Braze matches the user on. May be “external_id”, “braze_id”, “email”, or “phone”. Braze accepts only one identifier per request, so this choice decides which one Amperity sends. Note that “email” and “phone” are secondary identifiers in Braze and match a user only when no primary identifier is present on the request.

Identifier attribute

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

Only update 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 customer.

Braze user attributes

Attributes written to the Braze user profile. 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.

A campaign may be triggered by a change to one of these attributes rather than by the event name, which lets a single Activate node feed several campaigns.