Referral Share Reminder

This event is triggered after a certain amount of days that a referred customer had not submitted a purchase in. This is great for sending an email to remind the referred customer to use their friend's referral link to give both the referring and referred customer a reward.

Important AttributesDescription
emailThe email address of the recipient of the referral link (the friend)
customer.first_nameThe name of the customer who shared their referral link.
referral_linkThe URL of the customer’s referral link being shared.
fromThe email address of the customer who shared their referral link.
{
    "topic": "swell/referral/share/reminder",
    "name": "Swell Referral Share Reminder",
    "email": "[email protected]",
    "referral_link":"http://rwrd.io/xcode2",
    "referral_code":"xcode2",
    "from":"[email protected]",
    "customer": {
        "total_spend_cents": 0,
        "total_purchases": 0,
        "perks_redeemed": 2,
        "last_purchase_at": null,
        "email": "[email protected]",
        "referred_by": "[email protected]",
        "points_earned": 375,
        "points_balance": 375,
        "points_expire_at": "2027-01-31T23:59:59.000Z",
        "first_name": null,
        "last_name": null,
        "last_seen_at": "2016-10-15T18:14:56.000Z",
        "third_party_id": "4302977345",
        "referral_code": {
            "code": "xcode2",
            "shares": 0,
            "facebook_shares": 0,
            "twitter_shares": 0,
            "email_shares": 0,
            "emails_sent": 0,
            "emails_viewed": 0,
            "links_clicked_from_email": 0,
            "links_clicked_from_twitter": 0,
            "links_clicked_from_facebook": 0,
            "orders": 1,
            "amount_cents": 3000,
            "average_amount_cents": 3000,
            "expires_at": null,
            "expired": false,
            "completed_referral_customers": [{
                "email": "[email protected]",
                "first_name": "Hillary",
                "last_name": "Clinton",
                "referral_points_contributed": 0,
                "last_seen_at": "2016-10-15T16:38:20.000Z"
            }],
            "email": "[email protected]",
            "unique_clicks": 1,
            "total_clicks": 1
        }
    }
}

customer.points_expire_at

Sample payloads above use "2027-01-31T23:59:59.000Z" when an expiration date applies (Last Activity or Date Earned policies); the field is null when your policy is Never expire.

The date when the customer's points are set to expire. The value depends on your store's Points expiration policy:

  • Last Activity — Returns the calculated expiration date based on the customer's last activity.
  • Date Earned — Returns the next upcoming expiration date across all point batches.
  • Never expire — Returns null.

For Date Earned policies, customers may have multiple point batches with different expiration dates; this field reflects only the closest upcoming expiration.

The same semantics apply to GET /v1/customers, GET /v2/customers, and GET /api/v2/customers (Fetch Customer Details and Fetch All Recently Updated Customers).