Skip to main content

Getting started with Braze and Okendo

Create more personalized multi-channel Okendo campaigns with the Braze Integration.

Amanda Calderon avatar
Written by Amanda Calderon
Updated over a week ago

Integrating Braze with Okendo enables you to send review requests via various channels to customers who have opted into the campaign while continuing to target other customers with review request emails.

💡 The Braze integration with Okendo works across multiple products in Okendo's platform, including Reviews, Loyalty, Referrals, Surveys and Quizzes.

In this article, you'll learn about:

Authorizing Okendo to access Braze

Open Okendo and navigate to Settings > Integrations > Email & SMS > Braze

Add the API Endpoint (REST Endpoint) and API Key (Identifier) to the Integration settings.
​
You can find more information on how to create get your API Endpoint and API Key in the Braze API Guide.

Click on Save after adding the API details.

💡 To update the API information, disconnect using the Disconnect button, add new API details, and Save.

Advanced Settings

The external_id field used to identify the user associated with each event can be configured. Toggle on Use Shopify Customer ID for Braze user identification to associate the field with Shopify Customer IDs. Otherwise toggle it off to associate it with each user's email address.

Sample event data

After you integrate with Braze, Okendo sends a test payload to Braze with a data sample that allows you to create your initial Canvas in Braze. You can view all the events and properties sent to Braze here.

Using Braze with Okendo products

Depending on the Okendo product, you must complete additional steps to use Braze and Okendo together.

Reviews

Integrating Reviews with Braze

Loyalty

Integrating Loyalty with Braze

Referrals

Integrating Referrals with Braze

Surveys

Integrating Surveys with Braze

Quizzes

Integrating Quizzes with Braze

Event variables that Okendo sends to Braze

Event name

Properties

Okendo Review Created

Event Properties

is_recommended: true
language_code: "en"
overall_sentiment: positive
photo_count: 2
photo_urls: ["<https://i.imgur.com/PU37h8I.jpg>" "<https://placehold.co/600x400/EEE/31343C>"]
product_name: Small Cat Toy
product_url: <https://example.myshopify.com/products/t-shirt>
product_id: 123456
review_body: I cannot believe how much I love this new product
review_title: My New Favourite Product
review_created_date: 2024-09-18T06:45:38.244Z
reviewer_country_code: AU
reviewer_display_name: Bob M.
reviewer_full_name: Bob McGee
reviewer_zone_code: Austalia/Sydney
variant_name: 'Large'
video_count: 1
product_id: 123456
rating: 4
sku: 111
source: write-review-button
variant_id: 654321
coupon_code: OKR-DISCOUNT-CODE
coupon_description: $5 off your next order
loyalty_events: OkendoLoyaltyEvent
loyalty_points: 100
loyalty_provider: LoyaltyLlama
// Additional Review attributes
size_purchased: 4
body_shape: Hourglass
size_purchased: 12 / L

Customer Properties

okendo_average_review_rating: 4
okendo_has_submitted_media: true
okendo_latest_review_rating: 4
okendo_number_of_reviews: 1

Okendo Review Request

review_request_id: 00000000-0000-0000-0000-000000000000
email_address: example@okendo.io
first_name: John
last_name: Smith
order_fulfilled_date: 2024-08-12 05:35:58
order_number: TEST_0001
review_request_id: 00000000-0000-0000-0000-000000000000
email_address: example@okendo.io
first_name: John
last_name: Smith
order_fulfilled_date: 2024-08-12 05:35:58
order_number: TEST_0001
products: [{"Image Url":"<https://cdn.shopify.com/s/files/1/0667/7587/5864/files/Screenshot2024-08-01at4.57.16PM_4dbbf2b5-315d-4d2f-a265-02749dc2b4bb.png?v=1722499130","Review> Rating Urls":[{"Stars":1,"Url":"<https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true&rating=1"},{"Stars":2,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true&rating=2"},{"Stars":3,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true&rating=3"},{"Stars":4,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true&rating=4"},{"Stars":5,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true&rating=5"}],"Review> Url":"<https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-1234&testMode=true","Variant> Name":"Bronze","Name":"Large Shirt"},{"Image Url":"<https://d3nkw6if6g5fiy.cloudfront.net/test/1/emails/review/product-placeholder.png","Review> Rating Urls":[{"Stars":1,"Url":"<https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true&rating=1"},{"Stars":2,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true&rating=2"},{"Stars":3,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true&rating=3"},{"Stars":4,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true&rating=4"},{"Stars":5,"Url":"https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true&rating=5"}],"Review> Url":"<https://dp4p619kfd3mu.cloudfront.net/?subscriberId=12345&productId=shopify-7964778135832&testMode=true","Variant> Name":"Default Title","Name":"T Shirt"}]
product_i_ds: [123464,12346],
variant_ids: []

Sent Okendo Referral

locale: en
referrer_first_name: John
referrer_last_name: Smith
invitation_url: <https://test.oken.do/asd08e0as-asdsad&recipientType=invited>
recipient_email: example@okendo.io
customer_role: referrer
date_sent: 2024-11-05T07:36:18.560Z

Opted In to Okendo Referrals

Recipient event

customer_role: recipient
date_opted-In: 2024-11-05T07:37:47.959Z
invitation_link: <https://test.oken.do/o58t6ljm?referralId=34afdsfdsf&recipientType=anonymous>
locale: en
recipient_email: example@okendo.io

Referrer Event

customer_role: referrer
date_opted_in: 2024-11-05T07:37:47.959Z
invitation_link: <https://test.oken.do/o58t6ljm?referralId=34afdsfdsf&recipientType=anonymous>
locale: en

Okendo Referral Invitation

locale: en 
referrer_first_name: John 
referrer_last_name: Smith 
invitation_url: <https://test.oken.do/o58t6ljm?referralId=34afdsfdsf&recipientType=invited> recipient_email: example@okendo.io customer_role: recipient 
date_sent: 2024-11-05T07:37:47.959Z

Received Okendo Referral Coupon

coupon_code: OKR0-00000-TEST
coupon_description: $10 off first order
coupon_expiry_date: 2024-08-12T05:36:01.049Z
date_received: 2024-08-12T05:35:55.144Z
customer_role: recipient

Redeemed Okendo Referral Coupon

date_redeemed: 2024-08-12T05:35:55.144Z
customer_role: referrer
order_discount_amount: 10
order_id: TEST123456789
order_number: TEST_0001
order_total_price: 50

Okendo Referral Rejected

Recipient Event

customer_role: recipient
should_notify_customer: true
rejection_reason: Invalid
email: example@okendo.io
locale: en
rejection_type: manual

Referrer Event

customer_role: referrer
should_notify_customer: true
rejection_reason: Invalid
email: example@okendo.io
locale: en
rejection_type: manual

Enrolled in Okendo Loyalty

No properties for this event

Okendo Loyalty Points Awarded

points_earned: 30
description: Placed an Order
action: Placed An Order

Okendo Loyalty Points Redeemed

points_spent: 100 description: Coupon Used coupon_code: 00000000-0000-0000-0000-000000000000 coupon_description: Sample Coupon

Okendo Loyalty Tier Changed

earning_period_end: 2025-06-19T02:44:44.415Z
is_tier_upgrade: true
old_tier: Bronze
new_tier: Silver

Okendo Loyalty Points Adjusted

adjusted_amount: 42
adjusted_description: Sample Points Adjustment

Rolling Year

current_tier: "Bronze",
next_tier: "Silver",
spend_to_upgrade_tier: "100",
spent_within_tier_upgrade_window: "30",
tier_upgrade_window_end_date: "2025-02-25T23:18:59.498Z"

Lifetime

current_tier: "Bronze",
next_tier: "Silver",
spend_to_upgrade_tier: "100",
all_time_spend: "50"

Submitted Okendo Quiz

Quiz with Recommended Products

0: {"question":"Preferred brewing method?","answer":"Pour over"}
1: {"question":"Roasts you enjoy","answer":["Light", "Medium"]}
2: {"question":"Do you brew while camping?","answer": "No"}
quiz_name: What is the best coffee for you?
recommended_products: [{"ProductID":"12345","Product Name":"Glass Pour Over","Product URL":"<https://okendo-example.myshopify.com/products/glass-pour-over>", "Product Image Url":"<https://cdn.shopify.com/s/files/1/0667/7587/123123/files/Screenshot2024-07-15at11.36.56AM_69aba40f-7620-44a9-b262-308536234560.png?v=1722499105>}
recommended_product_i_ds: [123,456,789]
preferred_brewing_method: Pour Over
roasts_you_enjoy: ["Light", "Medium"]
do_you_brew_while_camping: No

Quiz with Redirect URL

0: {"question":"What Size shirt are you?","answer":"Small"}
quiz_name: What Shirt to Buy - RedirectUrl
quiz_response_id: 12345
redirect_url: <https://okendo-example.myshopify.com>
what_size_shirt_are_you: Small

Submitted Okendo Survey

survey_name: Sample Survey
email_address: example@okendo.io
first_name: Jane
last_name: Smith
sample_email_question: example@okendo.io
sample_5_point_question: 5
sample_multi_select_question:[ Sample Multi-select Answer #1, Sample Multi-select Answer #2, Sample Multi-select Answer #3]
sample_nps_question: 5
sample_single_select_question: Sample Single Select Answer
sample_star_question: 5
sample_text_question: Sample Text Answer

Custom attributes that Okendo sends to Braze

Okendo sends user profile data as custom attributes in Braze which can be used to create audience segments. Examples include:

  • Profile questions asked in surveys and during a review submission such as: Age, Birthday, Skin Type and Hair Color

  • Review metrics such as Average Review Rating and Average Review Sentiment

  • Loyalty metrics such as Points Balance and VIP Tier

  • Referrals metrics such as No. of Successful Referrals and Total Referral Revenue

  • NPS Score collected from a survey
    ​
    ​

Related Articles
Integrating Gorgias with Okendo
Importing Reviews Using the Okendo Import Template
How to integrate Kustomer with Okendo
Integrating Omnisend with Okendo
Getting started with Attentive and Okendo
Did this answer your question?