How To Enable The Braze integration

Use Friendbuy and Braze to accelerate email and SMS subscriber growth and seamlessly communicate with your email and SMS subscribers using referral and loyalty event data that is sent to Braze from Friendbuy.

Installation Instructions

  1. Rest EndPoint is needed to integrate with Braze. This can be found here.
    1. Use the table provided on the API overview page to match the URL of the dashboard you use to the correct REST Endpoint.
    2. To find your URL, log into Braze, If the URL you see is https://dashboard-01.braze.com, the corresponding Rest Endpoint would be https://rest.iad-01.braze.com.
    3. If you need assistance, open a support ticket.
  2. Confirm your API-Key. In your Braze account, go to Settings > API Keys. A REST API key is required with every request to the Braze API. When generating a new API key, be sure to select User Data and Email permissions. The API Key gives you access to your data for a workspace.
  3. Log into your Friendbuy account and go to Developer Center > Integrations tab > click on Add integration on the Braze integration card.
  4. Paste your REST Endpoint, and your API Key in the provided fields.

Click Install Integration....

  1. Go back into your Friendbuy account and refresh the page to confirm the Braze integration has been successfully installed. A blue checkmark and success message will appear on the card confirming installation.

How customer data is sent to Braze

Customer data collected in your referral program will be added to the respective Braze profile after a customer interacts with your referral program widgets. Email is used as the identifier for creating and updating Braze profiles. Important to note, customer data will only be sent to Braze if the customer opts-in through the referral widget by selecting the opt-in boxes.

For example, if a customer enters both their email and phone number in the widget but only checks the opt-in box for email marketing (and leaves the SMS marketing opt-in box unchecked), then only the email address will be sent to Braze. If a customer submits their contact information without either opt-in box checked, customer data will not be sent to Braze since consent was not collected.

The opt-in checkboxes are required to collect consent from the customer indicating they would like to receive additional emails and/or SMS messages from your company. See an example referral widget below:

Note: We use the international standard (E.164) to confirm valid phone numbers. If an invalid number is submitted, it will not be sent to Braze. Ex: 555-555-5555

Friendbuy Custom Attributes
Definition

Friendbuy Referral Status

Referrers are categorized as Advocate and referees are categorized as Referred Friend

Friendbuy Customer Name

The name the customer entered when submitting their info through a referral widget

Friendbuy Referral Link

A personal referral link (PURL) generated for an Advocate. For example, https://fbuy.io/EzcW

Friendbuy Date of Last Share

The date and time the Advocate last shared with a Friend via any share channel. If the Advocate has not shared yet, the property won't be visible.

Friendbuy Campaign ID

The Campaign ID associated with the personal referral link generated for an Advocate

Friendbuy Campaign Name

The Campaign Name associated with the personal referral link generated for an Advocate

Friendbuy Coupon Code

The most recent Referral coupon code distributed to the customer.

Note: only one code will be displayed

Friendbuy Coupon Value

The currency value of the most recent coupon code distributed to the customer.

Friendbuy Coupon Status

The status of the most recent coupon code distributed to the customer.

Note: status will be 'distributed' or 'redeemed'

Friendbuy Coupon Currency

Currency code (USD, CAD, etc.) or percent (%) associated with the most recent coupon code distributed to the customer.

Friendbuy Coupon Campaign ID

The Campaign ID associated with the coupon code generated for a customer.

Friendbuy Referred Revenue

The total amount of referred revenue from the Advocate

Friendbuy Referred Purchase

The number of purchases made from the Advocates referrals

Friendbuy Loyalty Opt-In Date

The date in which the customer enrolls in loyalty program

Friendbuy Customer Birthday

Birthday entered by customer in the referral widget

Friendbuy Member Tier Name

The name of the tier the customer is currently in

Friendbuy [Points Label] Balance

Number of points the customer has available to redeem for a reward

Friendbuy Account Credit Balance

The credit amount a customer has available to spend, if any

Loyalty Program Events

Friendbuy Custom Events for Referral Programs
Definition

Event Properties

Friendbuy Advocate Created

Customer submits their name, email and/or phone number in an Advocate widget on your site

  • Friendbuy Referral Link
  • Friendbuy Campaign Name
  • Friendbuy Customer Name

Friendbuy Referred Friend Created

Customer submits their name, email and/or phone number in a Friend widget on your site

  • Friendbuy Campaign Name
  • Friendbuy Customer Name

Friendbuy Referral Share

Advocate shares the referral program offer through the widget with a Friend via Email, PURL, SMS or Social (Facebook, Messenger, Twitter)

  • Friendbuy Share Channel
  • Friendbuy Campaign Name
  • Friendbuy Customer Name

Friendbuy Referral Advocate Reward Earned

Advocate earns a reward after a referred Friend completes the referral conversion event and passes all business rules/fraud checks

  • Friendbuy Coupon Code (includes: Code Bank & Shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name

Friendbuy Referral Friend Incentive Earned

Referred Friend completes the referral conversion event, passes all business rules/fraud checks, and then earns an incentive

  • Friendbuy Coupon Code (includes: Code Bank & Shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name

Loyalty Program Events

Reward customers for any of the following events that Friendbuy is sending to Attentive.

Friendbuy Custom Events for Loyalty Programs
Definition

Event Properties

Event Details

Friendbuy Loyalty Reward Earned from Joining Program

Loyalty member joins the program, passes all associated earning event rules, and earns a reward

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Any custom Attributes provided in the event payload

Friendbuy Loyalty Reward Earned from a Purchase

Loyalty member makes a purchase, passes all associated earning event rules, and earns a reward

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Any custom Attributes provided in the event payload

Friendbuy Loyalty Reward Earned from Referring a Friend

Loyalty member refers a friend, passes all associated earning event rules, and earns a reward

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Any Custom Attributes provided in the event payload

Friendbuy Loyalty Reward Earned from a Sign Up

Loyalty member completes a designated sign up event, passes all associated earning event rules, and earns a reward

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Any custom attributes provided in the event payload

Friendbuy Loyalty Reward Earned from a Custom Event

Loyalty member completes a designated custom event, passes all associated earning event rules, and earns a reward

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Name of Custom Event
  • Any custom attributes provided in the event payload

Friendbuy Loyalty Reward Earned

Loyalty member completes any earning event

  • Friendbuy Coupon Code (Include code banks and shopify coupons)
  • Friendbuy Reward Value
  • Friendbuy Reward Currency (Include Account Credit & Points)
  • Friendbuy Campaign Name
  • Friendbuy Customer Name
  • Any custom attributes provided

Friendbuy Member Tier Changed

Loyalty member tier has changed

  • Friendbuy Member Tier Name
  • Any custom attributes provided

How did we do?

Contact