Braze Integration

With Braze Integration, you can send data from Voucherify API to Braze. This allows you to trigger messages to be sent using Action Based Delivery. Additionally, you can synchronize Braze audience IDs to Customer metadata. This feature allows the creation of promotions targeted at specific customer groups segmented in Braze.

The integration with Braze consumes API limits for Connected Content and webhook limits for sending codes to Braze with custom attributes.

How does it work?
Events Sent to Braze
Tracking Events
Action Based Delivery
Updating Voucherify Customer Segments
Sending Events through Braze Webhook Messages

How does it work?

The Inbound integration enable you to send Voucherify events to Braze.

First, connect your Voucherify account with Braze.

Copy the REST API Key from your Braze account (it should at least have a permission 'users.track')
Go to the Integrations directory in your Voucherify dashboard, find Braze and choose Connect.
Paste the copied API Key from Braze and choose Connect:

Events Sent to Braze

The following list portrays the list of events sent to Braze.

EVENTS.CUSTOMER.REDEMPTION.SUCCEEDED
EVENTS.CUSTOMER.REDEMPTION.ROLLBACK.SUCCEEDED
EVENTS.CUSTOMER.REDEMPTION.FAILED
EVENTS.CUSTOMER.REDEMPTION.ROLLBACK.FAILED
EVENTS.CUSTOMER.REWARD_REDEMPTIONS.CREATED
EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED
EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED
EVENTS.CUSTOMER.PUBLICATION.FAILED
EVENTS.CUSTOMER.REWARDED.MAIN
EVENTS.CUSTOMER.REWARDED.LOYALTY_POINTS
EVENTS.CUSTOMER.VALIDATION.SUCCEEDED
EVENTS.CUSTOMER.VALIDATION.FAILED

Tracking Events

Historical Search

Track events taking place in Braze by heading to Data → Custom Events in your Braze account or Analytics → Custom Events Report in the new view. Example of such an event would be action-based delivery.

Select the period of time and events that interest you from the available list (events that you send to Braze are automatically added to the search list).

Customer Specific Events

It is also possible to take a closer look at the actions performed by a specific user rather than general statistics by heading to Users → User Search or Audience → Search Users in the new view.

Action Based Delivery

Trigger notifications to be sent based on custom events. In the second step of the campaign creation process, Schedule, you can select action-based delivery. This type of campaign lets you use your custom events. From the list select Perform Custom Event and add it as a trigger.

Then another list will pop up with events that you have sent to Braze. Below you can see a screen shot showing three different events.

You can, as an example, send new codes to all customers who failed to redeem their vouchers and try to make up for their disappointment.

Note, that campaigns may use Connected Content script to publish a unique coupon code and send it in the Braze message. More information about it in this article.

Update Voucherify Customer Segments

The Braze Outbound Integration allows for one-way customer data synchronization from Braze to Voucherify with Braze Canvas Webhooks. You can create promotions targeted at specific customer groups segmented in Braze.

This integration is based on a call to a dedicated URL on Voucherify’s side and will bring the customer's audience_id existing in Braze into Voucherify.

Cluster	Webhook URL
Europe	https://braze.voucherify.io/braze/customer-webhook
United States	https://us1.braze.voucherify.io/braze/customer-webhook
Asia	https://as1.braze.voucherify.io/braze/customer-webhook
Remaining Clusters	https://{cluster}.braze.voucherify.io/braze/customer-webhook ; where {cluster} is your dedicated cluster

Structure	Details
Authentication	applicationId secretKey Note: The application keys can be found in the Voucherify Dashboard. Navigate to the Project Settings → Application Keys.
HTTP Method	POST
Request Body	The request body contains 3 required parameters and the rest are optional.

Request Body Parameters/Data Mapping

Parameter	Definition/Options/Mapping
action (required)	"add" to add members to the audience "delete" to remove members from the audience This operation either adds/removes the customer metadata field called `brazeAudiences` from the customer’s profile in Voucherify.
audience_id (required)	This audience ID will be stored in Voucherify's customer profile under Metadata in the form of: brazeAudiences: [ "brazeAudienceID" ]
user_id (required)	Braze `user_id`
email_address	The email maps directly to Voucherify's `email` field
first_name	The first name and last name will concatenate in Voucherify into the customer’s `name` field
last_name	The first name and last name will concatenate in Voucherify into the customer’s `name` field
country	This maps directly to the customer's address in Voucherify (the `country` address parameter)
city	This maps directly to the customer's address in Voucherify (the `city` address parameter)
phone_number	This maps directly to the customer's address in Voucherify (the `phone` parameter)

How to tie it all together in Braze

In Braze, create a new Canvas using the Canvas Flow editor
When you create a message, select Webhook with a blank template
Enter the URL of the endpoint in Webhook URL, i.e. https://{cluster}.braze.voucherify.io/braze/customer-webhook
Enter all the required parameters in the Request Headers
1. applicationId: Application ID
2. secretKey: Application Token
3. HTTP Method: POST
Enter all the required parameters in the Request Body
1. action: "add" to add members to the audience, or "delete" to remove members.
2. user_id: Use personalisation in the editor to add a Braze user ID, for example, "{{${user_id}}}".
3. audience_id: Type the ID of the audience to update, for example, 608.

Sending Events through Braze Webhook Messages

Build a Canvas with a webbook as a message channel to send events to Voucherify through Braze.

For example:

Mark a referral as complete by forwarding a Braze event to Voucherify,
Give a voucher to a customer when they register on your website.

Entry Schedule, Audience, and Send Settings

Configure when your users enter the Canvas and the sendout of the event to Voucherify.

Choose an entry schedule (when your users enter the Canvas) as Action-Based – a user performs an action to enter the canvas.
Choose the custom event from the drop-down list.
Provide a start time when the users will start entering the Canvas.
In Target Audience, choose All Users.
In Send Settings, choose All users including unsubscribed users.

Build Canvas

Configure your Canvas to send events from Braze to Voucherify.

In the flow, click Message.
In Messaging Channels, add a Webhook.
In the Settings tab, add the Braze integration keys from Voucherify.
1. In Voucherify, go to Home and Project Settings.
2. Scroll down to Integration Keys.
3. Copy your integration keys.
In Braze, provide your X-App-Token and X-App-Id.
Choose the POST method.
In the Compose section, add the following URL in Webhook URL.
https://api.voucherify.io/v1/events
In the Request Body, form the proper payload for the track event endpoint.

{
    "event": "user_registered",
    "customer": {
        "source_id": "{{${user_id}}}"
    }
}

Test the configuration by sending an event to a Braze profile. Check if it is forwarded to Voucherify.

Endpoint	/users/track
Payload	{ "events": [ { "external_id": "uniqueUserId", "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "user_registered", "time": "2024-03-07T19:03:52Z" } ] }