Skip to main content

Set Up Your Friendbuy Integration

Learn how to configure the Friendbuy integration to sync referral and loyalty data, personalize messages, and trigger SMS automations.

Friendbuy provides referral and loyalty solutions to ecommerce brands on Shopify.

By integrating Friendbuy with Postscript, you can:

  • Sync opted-in Advocate and Friend phone numbers directly to your Postscript subscriber lists

  • Trigger real-time SMS automations based on referral and loyalty events (shares, conversions, points, tiers, and rewards)

  • Personalize messages using Friendbuy properties like coupon codes, points balance, and member tier

  • Target Advocates and referred Friends separately—or with the same keyword—using Postscript keywords.

In this article, we discuss how to configure the integration.

Create a Postscript API Key


In this section, we'll walk you through how to generate a private API key that you'll need to authenticate the connection between Friendbuy and Postscript.

  1. Select your Shop Name in the side menu of your Postscript dashboard, then select API.

  2. Select Create Security Key Pair on the right side of the page, then confirm your action by selecting Yes.

  3. Add a label to your API key so you can track where this API key is being used.

  4. Select Show in the Private Key column to reveal your API key. Copy this key—you'll need to enter it into Friendbuy later.

Create Your Postscript Keywords


Friendbuy uses Postscript keywords to add phone numbers to your subscriber lists after customers opt in. You'll map a keyword to your Advocates and a keyword to your referred Friends (you can also use a single keyword for both). The message you add to each keyword will be the message subscribers receive when they opt into your SMS program.

  1. Select Acquisition in the side menu of your Postscript dashboard, then select Keywords.

  2. Select Create Keyword in the top-right corner of the page.

  3. Name your keyword. Aim for something that will allow you to easily identify that this keyword is associated with your Friendbuy integration (for example, a keyword for Advocates and a separate keyword for Friends).

  4. Select Save Keyword.

  5. You can customize your keyword reply and add additional actions via + Add Action if desired. This reply will be the message your subscribers receive once they subscribe.

  6. Be sure to activate your keyword before mapping it in Friendbuy.

Configure the Integration in Friendbuy


The remaining steps take place in your Friendbuy account. No custom code is required.

Add the Postscript Integration

  1. In your Friendbuy account, go to Developer Center in the top navigation, then select the Integrations tab.

  2. Locate the Postscript tile and click Add integration. The Postscript Integration setup panel will open.

Add and Validate Your API Key

  1. Paste the private API key you generated in Postscript into the API Key field.

  2. Click Save & validate. Friendbuy will verify the connection. Once validated, the Advocate Keyword and Friend Keyword dropdowns will populate with your available Postscript keywords.

Map Your Keywords

Select which Postscript keywords Friendbuy should apply when adding phone numbers to your subscriber lists after customers opt in:

  • Advocate Keyword — the keyword applied to customers who share referral links (advocates)

  • Friend Keyword — the keyword applied to referred friends who opt in

If you want to use the same keyword for both, check the Send Phone Numbers to the same Advocate and Friend Keywords checkbox and select a single keyword.

Configure Sync Settings

  • Subscriber sync — pushes opted-in Advocates and Friends to your Postscript subscriber lists automatically

  • Event sync — sends referral and loyalty events from Friendbuy to Postscript to trigger SMS automations

Both are enabled by default. We recommend keeping both on for the full integration experience.

Install the Integration

Once your API key is validated, keywords are mapped, and sync settings are configured, click Install integration. The integration status will update from Not connected to Connected, and the Last sync field will populate after the first sync completes.

What You'll See in Postscript


Once a subscriber is synced from Friendbuy, they will appear in your Postscript Conversations view with a full set of Friendbuy properties attached to their profile. These properties are available as personalization variables in any SMS flow or campaign you build in Postscript.

The following Friendbuy properties are passed to each subscriber profile in Postscript:

Property Name in Postscript

Description

Friendbuy Campaign ID

Unique ID of the Friendbuy campaign associated with this subscriber

Friendbuy Campaign Name

Display name of the Friendbuy campaign

Friendbuy Coupon Code

Coupon code distributed to this subscriber

Friendbuy Coupon Value

Value of the distributed coupon

Friendbuy Coupon Currency

Currency type for the coupon value (e.g. Points, USD)

Friendbuy Coupon Currency Symbol

Symbol for the coupon currency

Friendbuy Coupon Status

Status of the coupon (e.g. distributed, redeemed)

Friendbuy Coupon Campaign ID

Unique ID of the coupon campaign

Friendbuy Customer Name

Name of the Friendbuy customer

Friendbuy Consent Status

Whether the customer has consented (yes/no)

Friendbuy Consent Timestamp

Date and time consent was captured

Friendbuy Points Balance

Customer's current loyalty points balance

Friendbuy Member Tier Name

Customer's current loyalty tier name

Friendbuy Date of Last Share

Date and time of the customer's most recent referral share

Friendbuy Loyalty Opt-In Date

Date and time the customer opted into the loyalty program

TIP! Use properties like Friendbuy Coupon Code, Friendbuy Points Balance, and Friendbuy Member Tier Name as personalization tokens in your Postscript SMS flows to send highly relevant, data-driven messages.

Friendbuy Trigger Events


When Event sync is enabled, Postscript automations can use any of these Friendbuy events as triggers:

Friendbuy Event

Description

Referral Shared

Customer shares their referral link via any channel

Referral Converted

A referred friend completes a qualifying purchase

Referral Reward Issued

Advocate receives a reward for a successful referral

Points Earned

Customer earns loyalty points from a purchase or action

Points Redeemed

Customer redeems loyalty points for a reward

Tier Upgraded

Customer advances to the next loyalty tier

Reward Issued

A loyalty reward is issued to a customer

To use a Friendbuy trigger event in a Postscript automation, select Messaging, then Campaigns from the left menu, and select the Create Automation button in the upper right. Choose Create new automation, then select Create flow. Search for the Friendbuy event under Trigger event or property to trigger the automation.

Frequently Asked Questions


Does this integration require a developer?

No. The integration is configured entirely within the Friendbuy Developer Center using your Postscript API key. No custom code is required.

Which Friendbuy plan is required?

The Postscript integration is available on Friendbuy paid plans. Contact your Friendbuy Customer Success Manager to confirm availability for your tier.

Can I use this for both referral and loyalty programs?

Yes. Subscriber sync and event sync apply to activity across both Friendbuy's referral and loyalty products.

Is data synced in real time?

Yes. Friendbuy sends events and property updates to Postscript in real time as customers take actions in your program.

What if a customer is not yet a Postscript subscriber?

If a customer's phone number is not opted in as a Postscript subscriber, the event will be received but an SMS automation will not trigger. Make sure your opt-in flows are capturing phone numbers before relying on SMS automations.

What is the difference between the Advocate Keyword and the Friend Keyword?

Postscript uses keywords to identify and segment subscribers. Friendbuy maps these keywords separately so Advocates and referred Friends can be targeted with different SMS automations.

Is bidirectional sync supported?

Currently, the integration sends data from Friendbuy to Postscript.

Troubleshooting


Issue

Likely Cause

Fix

Keywords not loading in dropdowns

API key not yet validated

Click Save & validate before attempting to select keywords

Events not appearing in Postscript

Event sync is toggled off

Check Sync Settings and enable Event sync

Subscribers not syncing

Subscriber sync is toggled off

Check Sync Settings and enable Subscriber sync

Friendbuy properties missing from a subscriber profile

Sync has not yet completed

Wait a few minutes and refresh the subscriber profile in Postscript

Customer not receiving SMS

Not an opted-in Postscript subscriber

Verify subscriber and opt-in status in Postscript

Connection error on save

Incorrect or expired API key

Regenerate your API key in Postscript and re-enter it in Friendbuy

Integration showing "Not connected" after install

Install step was not completed

Ensure you clicked Install integration after configuring all fields

Get Support


Have questions? Please feel free to reach out to our Support team at [email protected] or via live chat.

For Friendbuy-related questions, contact [email protected] or visit the Friendbuy Help Center.

Need ongoing channel strategy guidance? Please fill out this form and we'll connect you to one of our certified partners.

Did this answer your question?