The Postscript integration sends each customer's points or store credit balance, VIP tier and other loyalty details to their Postscript subscriber profile. It also sends loyalty events, such as points awarded or a reward redeemed, that you can use to trigger SMS flows and personalise messages.
The Postscript integration is available on the Essential plan and above.
Before You Start
Loyalty details are only added to customers who are already Postscript subscribers. Mage finds each subscriber by their Shopify customer ID. Customers who are not subscribers are skipped.
Events only trigger messages for customers who are SMS subscribers.
Connect Postscript
In Mage Loyalty, go to Integrations, then Postscript.
Click the Postscript API Keys page link under the key field, and copy your private API key from Postscript.
Paste it into the Postscript API Key field.
Click Save API Key.
Mage checks the key with Postscript before saving it. Once connected, the status card shows the last four characters of your key and when a customer was last synced.
When Data Is Sent
A customer's loyalty details are sent to Postscript whenever their points or store credit, VIP tier or rewards change.
There is no button to sync every customer at once. Existing subscribers get their loyalty details the next time their loyalty data changes.
Customer Properties
These are the main properties added to your Postscript subscribers. The integration page lists every property your store sends.
Property | What it holds | Example |
magePointsBalance | The customer's current points. With store credit, their balance in cents. | 100 |
mageStoreCreditBalance | Store credit only. The balance as money. | $12.50 |
magePointsAsCashBalance | Points only. What the points balance is worth, when you have a flexible redemption reward. | $17.50 |
mageLifetimePoints | Total points earned. With store credit, total store credit earned in cents. | 500 |
mageRedeemedPoints | Total points redeemed. With store credit, total store credit spent in cents. | 400 |
mageVipTierName | The customer's current VIP tier. | Gold |
mageNextVipTierName | The next VIP tier they have not reached yet. | Platinum |
mageAmountToNextVipTier | How much more they need to reach that tier. | 380 |
mageDateOfBirth | The customer's birthday, if they gave one. | 1990-09-17 |
mageEnrolledDate | When they joined your loyalty program. | 2025-01-01 |
If your program runs on store credit, use mageStoreCreditBalance to show a balance in messages, because the properties with points in their name hold cents. Some extra properties, such as points to the next reward and points expiring next, are sent on the Growth plan and above. For the full list, see Postscript Customer Properties & Events.
Events
Once Postscript is connected, the Event Settings section on the integration page lists each event, in the Loyalty, Cashback and Referral tabs. Tick an event to send it, or untick it to stop. Changes are saved straight away.
Event | When it is sent | On by default |
Points Awarded | Points or store credit are added to a customer's balance. | Yes |
Points Pending | Points or store credit are earned but held until an approval period ends. | No |
Bonus Points Awarded | A tiered bonus campaign awards flat bonus points or store credit. | No |
Reward Redeemed | A customer redeems points or store credit for a reward. | Yes |
VIP Tier Changed | A customer moves up or down a VIP tier. | Yes |
Points Expiry Soon | A customer has points or store credit expiring within 7 days. | No |
Gift Reminder | A gift occasion reminder is due for a customer. | No |
Birthday | A customer earns their birthday reward. | No |
Photo Challenge Approved and Photo Challenge Rejected | You approve or reject a photo challenge submission. Only listed when you have a photo challenge rule. | No |
Cashback Credited | A customer earns cashback paid as store credit. | No |
Referral Invite Sent | An advocate emails a referral invite to a friend. | No |
Referral Claimed | A friend claims their referral discount. | No |
Referral Reward Earned | An advocate earns their reward after a friend's purchase. | No |
In Postscript the event names use underscores, for example Points_Awarded. If your program runs on store credit, the names stay the same. Amounts on the event are in cents, and the event also carries the amount as money, for example Credit-Awarded or Credit-Spent. Each event's properties are listed in Postscript Customer Properties & Events.
There is no test event for Postscript. To see an event arrive, trigger it for a customer who is an SMS subscriber. For example, increase their points or store credit from their customer page in Mage Loyalty and tick Send points earned notification (or Send store credit earned notification). This sends Points Awarded.
Disconnecting
Click Disconnect on the status card and confirm. Mage stops sending data to Postscript and removes your API key. Properties already in Postscript stay there.
Troubleshooting
It says "Failed to save API key"
Postscript did not accept the key. Copy the full private API key from your Postscript API Keys page and try again.
A customer has no Mage properties in Postscript
They need to be a Postscript subscriber linked to their Shopify customer account.
Their loyalty data may not have changed since you connected. Their properties are sent the next time it does.
An event is not triggering my flow
Check the event is ticked in Event Settings.
Check the customer is an SMS subscriber.
Store credit amounts look 100 times too big
Properties and event amounts with points in their name hold cents. Use mageStoreCreditBalance, Credit-Awarded or Credit-Spent to show the amount as money.
Need a hand? Reach us on the live chat or at [email protected].