This event is triggered when a customer shares their referral link to their friends. This is great for telling new customers that someone they know likes your store.

📘

Please note:

This webhook is relevant to Shopify merchants who joined Yotpo Loyalty & Referrals after August, 2024.

If you're joined earlier, please see this webhook.

Important AttributesDescription
referral_linkThe URL of the customer’s referral link being shared.
fromThe email address of the referring customer who shared their referral link.
{
  "topic": "yotpo/referral/shared",
  "name": "Yotpo Referral shared",
  "website_url": null,
  "store_name": "Dummy Store Name",
  "from": "[email protected]",
  "referral_link": "rwrd.io/ref_CODE33?e",
  "referral_code": {
    "code": "CODE33",
    "customer_id": 139,
    "total_shares": 6,
    "email_shares": 6,
    "sms_shares": 0,
    "whatsapp_shares": 0,
    "copy_link_shares": 1,
    "personal_email_shares": 0,
    "links_clicked_from_email": 48,
    "links_clicked_from_sms": 0,
    "links_clicked_from_whatsapp": 0,
    "links_clicked_from_personal_email": 0,
    "links_clicked_from_copy_link": 1,
    "friends_orders": 0,
    "friends_amount_spent_cents": 0,
    "friends_average_amount_cents": 0,
    "expired": false,
    "customer": null,
    "completed_referral_customers": [
      {
        "email": "[email protected]",
        "first_name": "dd",
        "last_name": "cdd",
        "reward_type": "REWARD_OPTION",
        "referral_status": "COMPLETED",
        "last_seen_at": "2024-08-04T06:45:17.000Z"
      }
    ],
    "email": "[email protected]",
    "unique_clicks": 21,
    "total_clicks": 55
  },
  "redemption_option": {
    "id": 1,
    "cost_text": null,
    "amount": null,
    "applies_to_product_type": null,
    "duration": null,
    "type": "shopify_fixed_amount_coupon",
    "discount_amount_cents": null,
    "discount_rate_cents": null,
    "discount_percentage": null,
    "discount_type": null,
    "discount_value_cents": null,
    "name": "$10 off",
    "description": null,
    "unrendered_name": null,
    "unrendered_description": null,
    "cart_greater_than": null,
    "discount_with_currency": null
  },
  "email": "[email protected]",
  "customer": {
    "total_spend_cents": 281990,
    "total_purchases": 4,
    "perks_redeemed": 21,
    "last_purchase_at": "2024-08-08T06:09:15.000Z",
    "first_name": null,
    "last_name": null,
    "is_member": false,
    "accepts_marketing": false,
    "email": "[email protected]",
    "points_balance": 4743,
    "points_earned": 4843,
    "last_seen_at": "2024-08-08T06:12:32.000Z",
    "thirty_party_id": "8201609314590",
    "third_party_id": "8201609314590",
    "referral_link": "",
    "referral_discount_code": "",
    "is_opt_in": true,
    "loyalty_opt_in_date": "2024-07-31",
    "has_store_account": false,
    "credit_balance": "$0",
    "credit_balance_in_customer_currency": "$0",
    "is_affiliate": false,
    "points_expire_at": null,
    "referred_by_customer": null
  },
  "published_at": "2024-08-08T07:35:43.340+00:00"
}