Skip to main content

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Appstle Loyalty integrates natively with Shopify Flow, giving you 8 event triggers and 6 actions. You can automate loyalty workflows entirely within Shopify’s no-code automation builder — no webhooks or API calls required.

​
Triggers

Triggers fire when loyalty events occur in Appstle and pass customer and loyalty data into your Flow workflow.
TriggerHandleDescription
Loyalty Sign Uployalty-sign-upCustomer joins the loyalty program
Loyalty Points Earnedloyalty-points-earnedCustomer earns loyalty points
Loyalty Points Redeemedloyalty-points-redeemedCustomer redeems points for a reward
Loyalty Credits Earnedloyalty-credits-earnedCustomer earns store credits
Loyalty VIP Tier Achievedloyalty-vip-tier-achievedCustomer reaches a new VIP tier
Customer’s Birthdaybirthday-triggerTriggered on the customer’s birth date
Referral Reward Createdreferral-reward-createdA reward is created for the referring customer
Referred Reward Createdreferred-reward-createdA reward is created for the referred customer

​
Trigger properties

All triggers include a customer_reference (Shopify customer reference) and a Note string describing the activity. The three points and credits triggers (loyalty-points-earned, loyalty-points-redeemed, loyalty-credits-earned) additionally include:
  • Points or Credits — the decimal amount earned or redeemed
  • Earn Rule ID or Redeem Rule ID — the rule that triggered the activity
Every trigger also carries a nested Customer Loyalty Details object:
FieldTypeDescription
availablePointsFloatCurrent redeemable points balance
pendingPointsFloatPoints awaiting approval
creditedPointsFloatTotal lifetime points earned
spentAmountFloatTotal amount spent by the customer
currentVipTierStringActive VIP tier name (empty if none)
referredCompletedIntNumber of completed referrals
referralLinkStringCustomer’s unique referral URL
dobStringDate of birth in ISO format (if set)
rewardedForFacebookBooleanFacebook like reward earned
rewardedForTwitterBooleanX/Twitter follow reward earned
rewardedForInstagramBooleanInstagram follow reward earned
rewardedForYoutubeBooleanYouTube subscribe reward earned
rewardedForTiktokBooleanTikTok follow reward earned
rewardedForNewsLetterBooleanNewsletter signup reward earned
rewardedForSmsBooleanSMS signup reward earned
rewardedForCreatingAccountBooleanAccount creation reward earned
rewardsArrayList of CustomerReward objects
Each item in the rewards array contains:
FieldTypeDescription
descriptionStringReward description
discountCodeStringGenerated Shopify discount code
statusRewardStatusUSED, UNUSED, or REFUNDED
pointTransactionIdIntInternal transaction ID
pointRedeemRuleIdIntRedemption rule ID
orderIdIDShopify order ID (if reward was used)
orderNameStringOrder name (e.g., #1002)
createAtStringCreation timestamp
usedAtStringTimestamp when used (if applicable)
expireDateStringExpiry timestamp
variantIdIDProduct variant ID (for free product rewards)
The Flow schema exposes a subset of fields from the full customer loyalty object. Fields such as storeCreditBalance, vipTierExpiredAt, rewardedForSharingOnFacebook, and rewardedForSharingOnX are present in webhook payloads but are not available in Shopify Flow.

​
Actions

Actions let your Flow workflows modify loyalty data in Appstle.
ActionHandleDescription
Add Pointsadd-pointsAward loyalty points to a customer
Remove Pointsremove-pointsDeduct loyalty points from a customer
Add Store Creditsadd-store-creditsAward store credits to a customer
Remove Store Creditsremove-store-creditsDeduct store credits from a customer
Reward Points for Reviewsreward-points-for-reviewsAward points for a product review submission
Assign VIP Tierassign-vip-tierAssign or change a customer’s VIP tier

​
Add Points

FieldKeyTypeRequiredDescription
Customer Identifiercustomer-identifierStringYesCustomer ID or email — use {{customer.email}}
Points To AddpointsToAddStringNoNumber of points to award
Rule Idrule-idIntegerNoStatic rule ID from Appstle Loyalty
ReasonreasonStringYesShown to the customer in their transaction history
The points (Decimal) field is deprecated. Use pointsToAdd instead. If you see the old field in an existing action, remove and re-add the action block to get the current version.

​
Remove Points

FieldKeyTypeRequiredDescription
Customer—customer_referenceYesShopify customer reference
Points To RemovepointsToRemoveStringYesNumber of points to deduct
ReasonreasonStringYesShown to the customer

​
Add Store Credits

FieldKeyTypeRequiredDescription
Customer—customer_referenceYesShopify customer reference
Store Credits To AddstoreCreditsToAddStringYesAmount in store currency
ReasonreasonStringYesShown to the customer

​
Remove Store Credits

FieldKeyTypeRequiredDescription
Customer—customer_referenceYesShopify customer reference
Store Credits To RemovestoreCreditsToRemoveStringYesAmount to deduct
ReasonreasonStringYesShown to the customer

​
Reward Points for Reviews

Use this action to automatically award points when a review is submitted through a supported platform.
FieldKeyTypeRequiredDescription
Customer Emailcustomer-emailStringYesUse the customer email variable from your trigger
Product IDproduct-idStringYesProduct ID variable from your trigger
Ratingreview-ratingStringYesReview rating value
Review Typereview-typeStringYesPlatform identifier (see below)
Images Countimage-countStringNoNumber of images attached to the review
Videos Countvideo-countStringNoNumber of videos attached to the review
Supported review-type values: 
REVIEWS_IO
AIR_REVIEWS
OKENDO
LEAVE_REVIEW_LOOX_IO
LEAVE_REVIEW_STAMPED_IO
LEAVE_REVIEW_PRODUCT_REVIEWS

​
Assign VIP Tier

FieldKeyTypeRequiredDescription
Customer Identifiercustomer-identifierStringYesCustomer ID or email
VIP Tier Namevip-tier-nameStringYesExact name of the tier as configured in Appstle
Lock Tierlock-tierStringNoSet to "true" to prevent automatic recalculation from changing the tier. Default "false".
ReasonreasonStringNoReason recorded in the audit log
The tier name must exactly match a VIP tier configured in your Appstle Loyalty settings — for example, "Gold" or "Silver". If the customer is already on the specified tier, no changes are made.

​
Pre-built Flow templates

Appstle provides ready-to-use Flow templates for common review platform integrations:
TemplateReview platform
Points for Reviews.ioReviews.io
Points for Okendo ReviewsOkendo
Points for Loox ReviewsLoox
Points for Air ReviewsAir Reviews
Points for Rivyo ReviewsRivyo
Install a template from the Shopify Flow template library and it will be pre-configured with the correct action fields for that platform.

​
Example workflows

Trigger: Loyalty Sign Up
  ↓
Action: Send email marketing
  Customer Email: {{customer.email}}
  Subject: "Welcome to our loyalty program"

Trigger: Loyalty VIP Tier Achieved
  Condition: currentVipTier equals "Gold"
  ↓
Action: Add customer tags
  Tags: "vip-gold"

Trigger: Customer's Birthday
  ↓
Action: Add Points
  Customer Identifier: {{customer.email}}
  Points To Add: 100
  Reason: "Happy Birthday bonus"

Trigger: Any trigger or condition
  ↓
Action: Assign VIP Tier
  Customer Identifier: {{customer.email}}
  VIP Tier Name: "Gold"
  Reason: "Upgraded via Shopify Flow"

Trigger: Okendo review submitted (via Okendo Flow trigger)
  ↓
Action: Reward Points for Reviews
  Customer Email: {{customer.email}}
  Product ID: {{product.id}}
  Rating: {{review.rating}}
  Review Type: "OKENDO"