​
Event Overview

The Added to favorites event indicates high intent. Use this to trigger reminder emails or notify users when a favorited item goes on sale.

​
Use Cases

  • Immediate confirmation messages
  • Price drop alerts for favorited items
  • Back-in-stock notifications
  • Low stock urgency alerts

​
Event Attributes

FieldTypeDescription
product_idstringUnique product identifier
product_namestringDisplay name of product
product_urlstringDirect link to product page
product_image_urlstringProduct image URL
skustringStock Keeping Unit
variant_idstringSpecific variant ID
variant_namestringVariant description
brandstringProduct brand
categorystringProduct category path
product_typestringType of product
pricenumberCurrent price
compare_at_pricenumberOriginal price
currencystringCurrency code
discount_amountnumberDiscount amount
discount_percentagenumberDiscount percentage
in_stockbooleanStock availability
inventory_quantityintegerCurrent stock level
low_stock_thresholdintegerLow stock warning level
total_favoritesintegerTotal items in favorites
favorites_list_idstringFavorites list identifier
added_fromstringSource location
previously_favoritedbooleanRe-favorited indicator

​
Payload Example

{
  "attributes": {
    "product_id": "PROD-456",
    "product_name": "Wireless Headphones",
    "product_url": "https://example.com/products/headphones",
    "product_image_url": "https://example.com/images/headphones.jpg",
    "sku": "HP-002",
    "variant_id": "VAR-BLUE",
    "variant_name": "Blue",
    "brand": "CocoonSound",
    "category": "Electronics > Audio",
    "product_type": "Accessories",
    "price": 249.99,
    "compare_at_price": 299.99,
    "currency": "USD",
    "discount_amount": 50.00,
    "discount_percentage": 16.67,
    "in_stock": true,
    "inventory_quantity": 12,
    "low_stock_threshold": 5,
    "total_favorites": 5,
    "favorites_list_id": "fav_list_123",
    "added_from": "product_page",
    "previously_favorited": false
  }
}