Contents

Overview

This guide will show you how you can create a Webhook campaign in Braze to assign offers to only specific users. This means only these particular users will see these offers. In order to do this you will need to create a config Offer in Sanity and then create a Braze webhook campaign to assign this offer to users that meet a specific criteria set in Braze (e.g. assign Veggie Whopper Offer to guests that replied to a survey that they are vegetarian).

Sanity Setup

1. Create a personalized (or config) Offer

Follow this guide to create the offer: Offers - Configuration Guide

2. Save the Loyalty Engine ID of the config offer to input into Braze after

3. Add the config (personalized) offer to Live Config Offers

• To access Live Config Offers navigate to Order-Level Content > Loyalty > Live Offers Configuration > Live Offers > Live Config Offers in Sanity.

Braze Webhook Campaign Setup

1. Login to Braze

Login to your braze account

2. Navigate to Campaigns

In the homepage, click on “Campaigns”

3. Create a new Webhook Campaign

Click on “Create Campaign”. Then click on “Webhook”.

4. Configure the Campaign Details

• Add the name of the campaign in the “Campaign Name” field

• Click on “Blank Template”

5. Compose the Webhook

Webhook URL

Example of Hot Webhook URL in Production:

https://euc1-prod-bk-loyalty-middleware.rbictg.com/bulk-action/hot/create-offer

Example of the Cold Webhook URL in Production:

https://euc1-prod-bk-loyalty-middleware.rbictg.com/bulk-action/cold/create-offer

the Webhook URL should always begin with the following format:

https://{reg}-{env}-{brand}-loyalty-middleware.rbictg.com

Where:

• Region {reg} variables:

  • euc1 EU Timezone Markets

  • apse1 APAC Timezone Markets

  • euw3 Iberia Timezone Market

• Environment {env} variables: dev, staging, qa or prod . Please always test with staging first.

• Brand {brand} variables: bk, plk or fhs (other brands are not supported in International markets yet).

Input the URL in the “Webhook URL” field

HTTP method

Keep this field set to “POST”. No changes needed here.

Request Body

Inside “Request Body” choose “Raw Text”

Then copy the format below and paste it inside the Raw Text field.

{
  "email": "{{${email_address}}}",
  "source": "braze-test",
  "rank": 123456,
  "configId": "Loyalty engine id of config offer",
  "ruleParams": {
    "startDate": "yyyy-mm-dd",
    "endDate": "yyyy-mm-dd"
  }
}

• configId → replace configId with the Loyalty Engine ID of the config offer you want to assign using Braze

• source → should be braze in Production; braze-test in lower environments (Dev, Staging)

• email → leave as is

• startDate and endDate → the endDate must be set after the startDate - this represents the duration of time the offer will be available for the guest in the guest app

• rank → (optional) field that 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)

"ruleParams": {
    "startDate": "{{ "now" | date:"%F" }}",
    "endDate": "{{ "now" | date:'%s' | plus:604800| date:"%F" }}"
  }

Request headers

• Scroll down to request headers section and click “Add New Header” 3 times

• Then input the below headers keys and their values (Content-type, x-region, and x-api-key)

Content-type

Content-Type: application/json

X-Region

x-region: gb

X-Api-Key

x-api-key: string

6. Test the offer is getting assigned to your guest

In the “Compose” section in Sanity click on “Test”. Then choose “Select existing user” from the dropdown “Preview message as user”. After this input the email address of your test user in the guest app. Last but not least, click on “Send Test”. Now the offer should show on the top of your offer list.