Skip to main content

Klaviyo: ReferralCandy events and custom properties

ReferralCandy events and custom properties you can use in your Klaviyo flows

Written by Adam

ReferralCandy's Klaviyo integration lets you push information about your referral, affiliate or loyalty campaigns and contacts from ReferralCandy to your Klaviyo account. Use ReferralCandy custom properties (profile fields) and events (metrics) to build your Klaviyo flows.

Before you start (important notes)

  1. The default campaign short code FREN is used as an example in this article. Your campaign may use a different short code, depending on what you set.

    1. Important: The examples below are placeholders only to show where your campaign short code appears. Do not copy/paste "FREN" into Klaviyo. Instead, insert the custom property using Klaviyo's Personalization button (merge tag picker) so the correct campaign property is selected.

  2. Each ReferralCandy campaign has its own unique short code, so there isn't a single custom property that works across all campaigns.

  3. Reminder: Always select the property from Klaviyo's Personalization picker (instead of typing RC FREN - … manually), especially if you have multiple campaigns.


Where to find (and edit) your campaign short code

Campaign short code (the campaign "ID")

  • Think of this as the campaign's ID — a short label ReferralCandy uses behind the scenes.

  • You'll see it show up in places like Klaviyo properties (example: "RC [short code] - …").

  • This is different from your campaign name (the label you see in ReferralCandy). Renaming a campaign does not change its short code.

  • You can edit the campaign short code only while the campaign is still in setup. Once activated (Live), it's locked and can't be edited.

To find or edit your campaign short code:

  1. Open ReferralCandy:

  2. Click Referral campaigns and select the campaign you want to edit.

  3. Under Get started, click Campaign details.

  4. Find the Campaign short code field. If the campaign hasn't been activated yet, you can edit it. Once Live, it's locked.

  5. (If editing) Click Save.


Custom properties (Klaviyo profile properties)

Below is a list of ReferralCandy custom properties you can use in Klaviyo. These properties appear on a Klaviyo profile and can be inserted into your email/SMS content using Personalization.

Important: Don't copy/paste the example property names below. Use Klaviyo Personalization to insert the correct one for the specific campaign you're using.

Profile custom properties

RC [Short code] - Name
The contact's name.
Example: "Alice"

RC [Short code] - Portal link
The contact's advocate portal link.
Example: https://yourstore.referralcandy.com/DXTMKK4

RC [Short code] - Referral link
The contact's referral link.
Example: https://yourstore.refr.cc/campaign/u/alice

RC [Short code] - Referred purchase accumulated
Total number of approved, rewardable referred purchases accumulated by the contact. A purchase can increase this count even when its reward tier gives no incentive.

Important clarification about what "approved" means:

  • A referred purchase is included in this count only once it becomes approved/rewardable.

  • This happens when either:

    1. The referred purchase has passed the review period (review deadline), or

    2. The referral has been manually approved (if manual approval is available in your account/platform).

  • Pending referrals (still within the review period) are not included in this count.

Example:
If a contact has 3 referred purchases detected, but 2 are still Pending (in review), and only 1 is approved/rewardable, then:
RC [Short code] - Referred purchase accumulated = 1

RC [Short code] - Referred purchase needed for next reward
​

Total number of approved referred purchases needed for the contact to qualify for the next reward.

Notes:

  • For campaigns using multiple reward tiers, this returns the number of referred purchases needed to qualify for the subsequent tier.

  • When the contact reaches the last tier, it depends on the tier setting you selected:

    • Keep giving last tier reward for each referral after completing final tier → value is 1

    • Stop rewards after the final tier → value is 0

    • Loop tiers → value is determined by the minimum number of referral(s) set for the 1st tier

  • Pending referrals (still in review) do not reduce this number until they become approved.

FlexiTiers example:
Tier 1 | 1–2 | 10% off
Tier 2 | 5+ | 50% off
​

If a contact made 2 referrals, the property returns 3 (they need 3 more approved referred purchases to reach Tier 2).

RC [Short code] - Next reward description
The description of the reward the contact will receive upon qualifying for their next referral reward.

  • The property returns the reward and description of the subsequent tier.

  • If there are no subsequent tiers, the property doesn't return a value.
    Example: "a 10% discount"

Sharing the friend offer
Use the campaign's Referral link property when asking advocates to invite friends. The Coupon code variable on an RC - Reward earned event is the advocate's reward coupon, not the referred friend's offer code.

Loyalty store-credit properties

For contacts enrolled in a loyalty campaign, look for these properties under that campaign's short code:

  • RC [Short code] - Store credit available

  • RC [Short code] - Store credit pending

  • RC [Short code] - Store credit earned lifetime

These are formatted amounts from the ReferralCandy loyalty campaign's records, not the customer's total Shopify store-credit balance. Use the loyalty campaign's Portal link to direct the customer to their rewards. Loyalty campaigns do not provide a referral link or next-referral-reward properties. Check the actual values on the profile before using them in an email.


Timestamp custom properties (debug/admin)

These properties show timestamp information based on actions done to a profile. They're intended for debugging/admin purposes. Values are in Unix format (example: "1660724560").

  • RC [Short code] - Banned at

  • RC [Short code] - Deleted at

  • RC [Short code] - Enrolled at

  • RC [Short code] - Unenrolled at

  • RC [Short code] - Unsubscribed at

  • RC [Short code] - Updated at


Inserting a custom property in Klaviyo

  1. In Klaviyo's editor, click Personalization for text blocks (or Add personalization in other text fields).

  2. Click the All types dropdown and select Custom.

  3. Select the ReferralCandy custom property you want to insert.

If you're running multiple campaigns, use your campaign short codes to confirm and identify the property belongs to the correct campaign.


Events and triggers (Klaviyo metrics)

The list below covers the events used in our referral and affiliate flow guides. Your Klaviyo account may show additional ReferralCandy metrics. Event variables describe the activity that triggered the flow; custom properties are values stored on the profile. ReferralCandy activity can update campaign-specific profile properties. A sample event used to check the integration does not prove those properties are populated for a contact. Check the relevant event and profile when previewing your email.

RC - Enrolled
Event variables: Campaign name; First time enrollment (True or False)
Triggered when a contact meets the campaign's segment criteria and becomes enrolled in your referral or affiliate campaign.

RC - Unenrolled
Event variables: Campaign name
Triggered when a previously enrolled advocate/affiliate no longer meets segment criteria and becomes unenrolled.

RC - Signup form submitted
Event variables: Campaign name; Form type
Triggered when a contact who was never enrolled in the campaign signs up via a form.
Form types include: Post-purchase popup (if signups are enabled), Referral extension (if signups are enabled), Referral widget, Join page, Embedded signup form.

RC - Waitlisted
Event variables: Campaign name; Form type
Triggered when a contact who was never enrolled doesn't meet the segment criteria after signup.

RC - Purchase referred by profile detected
Event variables: Campaign name; Currency; Purchase amount
Triggered when ReferralCandy attributes a purchase to the advocate. Attribution can come from a referral link, a friend offer code or a referral you assign manually; this event does not identify which method was used.
Note: This detection can happen before the referred purchase is approved (it may still be Pending during the review period).

RC - Purchase referred by profile made ineligible
Event variables: Campaign name; Reason
Triggered when a referred purchase is flagged as ineligible.

RC - Reward pending
Event variables: Campaign name; Pending date; Review deadline; Reward type; Reward amount; Reward currency; Coupon code
Triggered when a qualifying referral enters a finite review period and a reward is lined up. It does not mean the reward has been earned. A coupon that has not been generated yet can have the literal text None as its Coupon code.

Pending date and Review deadline are Unix timestamps. The deadline records the state when that event was sent; a later review extension can change the deadline in ReferralCandy without changing the earlier event. Do not promise delivery on that date or send a pending coupon as an earned reward. A referral that was frozen can send another RC - Reward pending event when its review period resumes, so allow for a repeated pending notification in your flow.

RC - Reward earned
Event variable: Campaign name
Reward variables, when an incentive is issued: Date earned; Reward type; Reward amount; Reward currency
Additional variables depend on the reward type:

  • Coupon: Coupon code; Coupon expiry date

  • Cash: Reward percentage; Portal login link

Triggered when an advocate earns a referral reward. A no-reward tier can also trigger this event with only Campaign name, without a reward type, amount, code or earned date. Do not treat every occurrence as an incentive earned. See Using segments in ReferralCandy and Klaviyo for filtering reward events. This event is also sent for store-credit grants in loyalty campaigns. Filter referral flows by Campaign name so they use the intended campaign. A coupon without an expiry date can have the literal text None as its Coupon expiry date; omit expiry text in that case. Date earned and a populated Coupon expiry date are Unix timestamps; format them as dates before displaying them in an email. Check Reward type and the reward fields your message needs before sending it. For a coupon email, require a coupon reward and a usable Coupon code; keep events with missing reward data out of that email step.

RC - Subscribed to campaign emails
Event variables: Campaign name
Triggered when a contact is subscribed to campaign emails.

RC - Unsubscribed from campaign emails
Event variables: Campaign name
Triggered when a contact unsubscribes from campaign emails.

RC - Banned from ReferralCandy
Triggered when you ban a contact.

RC - Removed from ReferralCandy
Triggered when you delete a contact from your ReferralCandy account.


Klaviyo events and custom properties FAQ

Why can't I see post-purchase, signup form, and invitation enrollment events in Klaviyo?

If you integrated Klaviyo with ReferralCandy before March 5, 2024, the following events are deprecated and no longer supported:

  • RC - Enrolled via post purchase

  • RC - Enrolled via signup form

  • RC - Enrolled via invitation

  • Enrolled in ReferralCandy through purchase

Use the RC - Enrolled event instead when setting up your Klaviyo triggers and flows.

Why is RC [Short code] - Referred purchase accumulated lower than the number of referrals I expect?

Most commonly, some referred purchases are still Pending (in the review period). Pending referrals aren't included until they become approved/rewardable (for example, after they pass the review deadline, or after manual approval if that's available in your setup).

Why is my Klaviyo email sending a blank referral link (or any blank ReferralCandy custom property)?

Start by checking the advocate's profile in Klaviyo. Go to Audience → Profiles, open the advocate's profile, and look at their custom properties. You'll see exactly which RC [Short code] - … properties exist for that contact, including the actual campaign short code their record is enrolled under. (To confirm the short code on the ReferralCandy side, see Where to find (and edit) your campaign short code earlier in this article.)

What you find on the profile narrows down the cause:

If no RC custom properties appear: check that you connected the intended Klaviyo account, that the contact is enrolled in the intended ReferralCandy campaign, and that you opened the matching Klaviyo profile. Look for recent ReferralCandy activity on that profile and check again after the activity has synced. A missing property alone does not identify the cause. If it stays missing, let us know which campaign and profile are affected.

If the RC properties are there but the email field is still blank, check the template reference and whether the property was available when the email was evaluated:

  • Wrong property selected. Confirm the property name matches the content you're trying to insert. The full list of available RC [Short code] - … properties is in the Custom properties section above. Properties ending in - Enrolled at, - Updated at, etc. are timestamp/debug fields and shouldn't be used for content. For URLs specifically, you want - Portal link (advocate portal) or - Referral link (the link advocates share with friends).

  • Property typed instead of inserted via the Personalization picker. Typing RC FREN - Portal link only works if your campaign's actual short code is FREN. Always insert via Klaviyo's Personalization button (merge tag picker) so the correct campaign property is wired in.

  • Trigger and timing. For an enrollment email, use RC - Enrolled as the metric trigger. Timestamp properties are debugging fields, not substitutes for the enrollment event. An unrelated trigger does not supply ReferralCandy event variables. If the profile properties have not arrived yet, add a time delay before the email and before any split that checks those properties, then test again. Check the profile properties and rendered links before activating the flow — see Klaviyo flows: Sending a referral email upon enrollment for correct setup.

Can I build the ReferralCandy referral or portal link manually in my Klaviyo template?

No. Each contact has a unique ReferralCandy URL generated per profile (for example, yourstore.refr.cc/campaign/u/alice or yourstore.referralcandy.com/DXTMKK4). A manually-constructed URL pattern won't render the correct per-contact link.

Always use property lookup via Klaviyo's Personalization picker. Example: {{ person|lookup:"RC [Short code] - Portal link" }} — with your campaign's actual short code in place of [Short code]. Preview with a profile enrolled in that campaign and open the rendered link. Do not use click here as a URL fallback: it is text, not a link. If the expected URL is missing, resolve that before sending.

Did this answer your question?