Benjamin Reynolds (Deactivated) recording → Targeted Coupons Through Braze-20220322_123641-Meeting Recording.mp4
Your RBI product or customer success team can tell you whether you should follow the “Traditional Offers Assignment” or “Loyalty Offers Assignment” flow for your market.
Traditional Offers Assignment
Sanity Setup
Use Required assignment ruleset
Add the offer to Feature Offers
please note that wherever you order the offer in the
Feature OfferList, is where the offer will show as available to the user
On the offer in sanity, set the
Requires Assignmentruleif there are other rules in the offer, make sure that the
Requires AssignmentRule is the LAST ONE listed
If the same offer is assigned multiple times, the user will not see the same offer added multiple times to their offer list. Instead, the already assigned offer will be updated with the new offer assignment settings
Find here documentation on Sanity rulesets.
Make sure that all the PLUs are set to the correct value. If set to Empty, the assigned offer won’t show in the offer list
Braze Configuration
Body request
{
"couponId": "0526d543-3871-4e9c-bec5-327ebcd3f1db",
"tokenId": "tester",
"userId": "{{${user_id}}}",
"email": "{{${email_address}}}",
"expiresOn": "2020-08-11T08:59:59.000Z"
}
Replace
couponIdwith the offer Sanity ID of the coupon you want to assigntokenIdshould be a unique identifier for each campaignemail-> leave as is
Note that in the past we relied on "userId": "{{${user_id}}}" , but after the EUC1 user data migration all campaigns should also include "email": "{{${email_address}}}"
expiresOn-> this field determines when the offer assignment will expire, so i.e. the end of the offer life
Request headers
Webhook URLs
US-East-1 (Americas Timezone Markets)
https://prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
EU-Central-1 (EU Timezone Markets)
https://euc1-prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
AP-SouthEast-1 (APAC Timezone Markets)
https://apse1-prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
Make sure you use v2 - in the past the URL used to be v1
If you would like to test in Staging the Offer assignment first, replace prod with staging in the Webhook URL.
Authorization
Authorization: Basic <Get this from your RBI Product or Customer Success Team>
Content-type
Content-Type: application/json
Loyalty Offers Assignment (Loyalty Offers Platform)
Sanity Setup
Create a template offer (e.g. template offer for Braze Offers in BK UK)
this offer can be used for all future Braze Offer Assignments
save the
Loyalty Engine IDof the template offer to input into Braze after
under
Mechanicsensure a config offer is added underConfig Offerand under theRequired Rulesdrop down theDate Bandtoggle is turned onit does not make a difference which config offer is within the template offer in Sanity - it just needs to be added so the offer can be Published
Create a Config Offer (e.g. config offer for for BK UK)
you will need a different Config Offer created for each offer you would like to assign using Braze
save the
Loyalty Engine IDof the template offer to input into Braze after
within this config offer, in the
Mechanicsdropdown underBenefitsyou will need to link the offer benefits (e.g. Picker or Offer Combo)
Make sure to add the config offer to the list of Live Config Offers in the
Loyalty Offers UIin Sanity, so the offer shows in the app to the user after it is assigned
If the same offer is assigned multiple times, the user will see the same offer added multiple times to their offer list. This means that the user will see multiple instances of the same offer in their offer list - as many as offer assignments done for that offer. Each offer will maintain their own configuration settings
Braze Configuration
Body request
{
"email": "{{${email_address}}}",
"source": "braze-test",
"rank": 123456, (optional)
"configId": "Loyalty engine id of config offer",
"ruleParams": {
"startDate": "yyyy-mm-dd",
"endDate": "yyyy-mm-dd"
}
}
Replace
configIdwith the Loyalty Engine ID of the offer you want to assign using Brazesourceshould bebrazein Production;braze-testin lower environments (Dev, Staging)email-> leave as is
Note that in the past we relied on "userId": "{{${user_id}}}" , but after the EUC1 user data migration all campaigns should use "email": "{{${email_address}}}"
startDateandendDate-> required fields; theendDatemust be set after thestartDate- this represents the duration of time the offer assignment will be available forrankfield (optional) determines the sequence priority of the assigned personalized offer. The lower the number, the higher the priority (i.e. 1 would rank at the top)
Request headers
Webhook URL
the Hot path should be used for any user triggered campaigns that should happen in realtime
ie: T-Mobile Tuesdays, sign up bonuses
the Cold path should be used for any marketer triggered campaigns that can be processed over time
ie: mass offers assignments, mass points updates
Example of Hot Webhook URL in Production:
https://prod-bk-loyalty-middleware.rbictg.com/bulk-action/hot/create-offer
Example of the Cold Webhook URL in Production:
https://prod-bk-loyalty-middleware.rbictg.com/bulk-action/cold/create-offer
If you would like to test in Staging the Offer assignment first, just replace prod with staging in the Webhook URL.
Markets in EU Timezone and APAC Timezone should add euc1- and apse1- prefixes to the URL respectively (e.g., https://euc1-prod-bk-loyalty-middleware.rbictg.com/bulk-action/cold/create-offer)
Content-type
Content-Type: application/json
X-Region
x-region: gb
x-region is the 2-character ISO country code string of that market (e.g. gb = United Kingdom, ch = Switzerland)
X-Api-Key
x-api-key: string
Please reach out to Lopes da Costa, Valentina or another PM to get you access to the API Key in Production or Staging for your brand
If we want to set the end date as X seconds after assignment, we need to use the below logic "ruleParams": {
"startDate": "{{ "now" | date:"%F" }}",
"endDate": "{{ "now" | date:'%s' | plus:604800| date:"%F" }}"
}
Other resources
Assign Loyalty Points to Users Using Braze Webhook
This can be used for all Markets with Loyalty
Body request
{
"pointsEarned": 500,
"source": "braze",
"email": "{{${email_address}}}"
}
Replace
pointsEarnedwith the amount of points you would like users that receive this Braze web hook to receivesourceshould bebrazein Production;braze-testin lower environments (Dev, Staging)email-> leave as is
Note that in the past we relied on "userId": "{{${user_id}}}" , but after the EUC1 user data migration all campaigns should use "email": "{{${email_address}}}"
Request headers
Webhook URL
the Hot path should be used for any user triggered campaigns that should happen in realtime
ie: T-Mobile Tuesdays, sign up bonuses
the Cold path should be used for any marketer triggered campaigns that can be processed over time
ie: mass offers assignments, mass points updates
Example of Hot Webhook URL in Production:
https://prod-bk-loyalty-middleware.rbictg.com/bulk-action/hot/assign-points
Example of the Cold Webhook URL in Production:
https://prod-bk-loyalty-middleware.rbictg.com/bulk-action/cold/assign-points
If you would like to test in Staging the Offer assignment first, just replace prod with staging in the Webhook URL.
Markets in EU Timezone and APAC Timezone should add euc1- and apse1- prefixes to the URL respectively (e.g., https://euc1-prod-bk-loyalty-middleware.rbictg.com/bulk-action/cold/assign-points)
Content-type
Content-Type: application/json
X-Region
x-region: gb
x-region is the 2-character ISO country code string of that market (e.g. gb = United Kingdom, ch = Switzerland)
X-Api-Key
x-api-key: string
Please reach out to Lopes da Costa, Valentina or another PM to get you access to the API Key in Production or Staging for your brand
