Versions Compared

Old Version 28

changes.mady.by.user Benet, Anton

Saved on

compared with

New Version 29

changes.mady.by.user Lopes da Costa, Valentina

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

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

...

Info

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

Code Block
languagejson
{
  "couponId": "0526d543-3871-4e9c-bec5-327ebcd3f1db",
  "tokenId": "tester",
  "userId": "{{${user_id}}}",
  "email": "{{${email_address}}}",
  "expiresOn": "2020-08-11T08:59:59.000Z"
}

...

  • 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)
Code Block
languagejson
https://prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
EU-Central-1 (EU Timezone Markets)
Code Block
languagejson
https://euc1-prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
AP-SouthEast-1 (APAC Timezone Markets)
Code Block
languagejson
https://apse1-prod-bk.rbictg.com/api/v2/braze/webhooks/assign-coupon-token
Info

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

Code Block
Authorization: Basic <Get this from your RBI Product or Customer Success Team>

Content-type

Code Block
languagejson
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 ID of the template offer to input into Braze after

    • under Mechanics ensure a config offer is added under Config Offer and under the Required Rules drop down the Date Band toggle is turned on

      • it 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

...

Info

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

Code Block
languagejson
{
  "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"
  }
}

...

  • startDate and endDate-> required fields; the endDate must be set after the startDate - this represents the duration of time the offer assignment will be available for

  • rank field (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
Info

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

...

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
Code Block
languagejson
Content-Type: application/json
X-Region
Code Block
x-region: gb
Info

x-region is the 2-character ISO country code string of that market (e.g. gb = United Kingdom, ch = Switzerland)

X-Api-Key
Code Block
x-api-key: string

...

Assign Loyalty Points to Users Using Braze Webhook

Tip

This can be used for all Markets with Loyalty

Body request

Code Block
languagejson
{
"pointsEarned": 500,
"source": "braze",
"email": "{{${email_address}}}"
}

...

Note

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
Info

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

...

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
Code Block
languagejson
Content-Type: application/json
X-Region
Code Block
x-region: gb
Info

x-region is the 2-character ISO country code string of that market (e.g. gb = United Kingdom, ch = Switzerland)

X-Api-Key
Code Block
x-api-key: string

...