Klaviyo/Omnisend Events Documentation

Events Reference

1. OrderPlaced

Triggered when: A giftcard purchase order is placed

Attributes

Attribute	Type	Description
`customer_email`	String	Recipient's email
`customer_phone`	String	Recipient's phone
`customer_name`	String	Recipient's name
`customer_first_name`	String	Recipient's first name
`customer_last_name`	String	Recipient's last name
`sender_email`	String	Sender's email
`sender_phone`	String	Sender's phone
`sender_name`	String	Sender's name
`sender_first_name`	String	Sender's first name
`sender_last_name`	String	Sender's last name
`card_number`	String	Gift card number
`card_pin`	String	Gift card PIN
`card_id`	String	Internal card ID
`original_value`	Decimal	Original card value (rounded down)
`balance`	Decimal	Current card balance (rounded down)
`currency`	String	Currency symbol
`expiration_date`	String	Card expiration date (formatted, "Never" if no expiration)
`barcode_url`	String	URL to card barcode image
`is_gift`	Boolean	Whether this is a gift
`greeting_message`	String	Gift message (if applicable)
`scheduled`	Boolean	Whether delivery is scheduled
`deliver_at`	String	Scheduled delivery date/time (formatted, "Never" if not scheduled)
`delivery_mode`	String	Delivery method (e.g., EMAIL, SMS)
`deliver_at_timezone`	String	Timezone for scheduled delivery
`delivered_to_sender`	Boolean	Whether delivered to sender instead of recipient
`company_name`	String	Store name
`store_name`	String	Store name
`giftcard_theme_url`	String	URL to gift card theme image
`loyalty_card_balance`	Integer	Recipient's loyalty points
`store_credit_balance`	Decimal	Recipient's store credit
`vip_tier`	String	Recipient's VIP tier
`client_order_id`	String	External/client order ID
`order_date`	String	Order creation date (formatted)
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`campaign_id`	String	Gift card campaign ID
`activity_type`	String	Transaction activity type

2. OrderScheduleConfirmation

Triggered when: A scheduled gift card order is confirmed (sent to buyer)

Attributes

Attribute	Type	Description
`order_id`	String	Order ID
`order_key`	String	Order key
`is_gift`	Boolean	Whether this is a gift
`scheduled`	Boolean	Whether delivery is scheduled
`card_value`	String	Card value with currency symbol (formatted string)
`delivery_mode`	String	Delivery method
`customer_name`	String	Buyer's name
`customer_email`	String	Buyer's email
`customer_phone`	String	Buyer's phone
`customer_first_name`	String	Buyer's first name
`customer_last_name`	String	Buyer's last name
`recipient_name`	String	Recipient's name
`recipient_email`	String	Recipient's email
`recipient_phone`	String	Recipient's phone
`recipient_first_name`	String	Recipient's first name
`recipient_last_name`	String	Recipient's last name
`deliver_at`	String	Scheduled delivery date/time (formatted with timezone)
`giftcard_theme_url`	String	URL to gift card theme image
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Buyer's loyalty points
`store_credit_balance`	Decimal	Buyer's store credit
`vip_tier`	String	Buyer's VIP tier
`client_order_id`	String	External/client order ID
`order_date`	String	Order creation date (formatted)
`campaign_id`	String	Gift card campaign ID

3. GiftcardRedeemed

Triggered when: A gift card is redeemed/used

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`card_number`	String	Gift card number
`card_pin`	String	Gift card PIN
`card_id`	String	Internal card ID
`original_value`	Decimal	Original card value (rounded down)
`balance`	Decimal	Remaining balance after redemption (rounded down)
`redemption_amount`	Decimal	Amount redeemed in this transaction (rounded down)
`currency`	String	Currency symbol
`expiration_date`	String	Card expiration date (formatted, "Never" if no expiration)
`company_name`	String	Store name
`store_name`	String	Store name
`transaction_type`	String	Type of transaction
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`client_order_id`	String	External/client order ID
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`campaign_id`	String	Gift card campaign ID
`activity_type`	String	Transaction activity type

4. StoreCreditRedeemed

Triggered when: Store credit is redeemed/used

Attributes

Same as GiftcardRedeemed

5. LoyaltyCardRedeemed

Triggered when: Loyalty points are redeemed

Attributes

Same as GiftcardRedeemed, with one exception:

Attribute	Type	Description
`balance`	Integer	Integer value (not rounded down) for loyalty points

6. GiftcardIssued

Triggered when: A new gift card is issued

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`card_number`	String	Gift card number
`card_pin`	String	Gift card PIN
`card_id`	String	Internal card ID
`original_value`	Decimal	Original card value (rounded down)
`balance`	Decimal	Current balance (rounded down)
`amount`	Decimal	Transaction amount (rounded down)
`currency`	String	Currency symbol
`expiration_date`	String	Card expiration date (formatted, "Never" if no expiration)
`company_name`	String	Store name
`store_name`	String	Store name
`giftcard_theme_url`	String	URL to gift card theme image
`barcode_url`	String	URL to card barcode image
`transaction_type`	String	Type of transaction
`greeting_message`	String	Gift message (included for ISSUED type)
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`campaign_id`	String	Gift card campaign ID
`activity_type`	String	Transaction activity type

7. GiftcardReloaded

Triggered when: A gift card is reloaded with additional funds

Attributes

Same as GiftcardIssued, excluding greeting_message

8. GiftcardRefunded

Triggered when: A gift card transaction is refunded

Attributes

Same as GiftcardIssued, with one addition:

Attribute	Type	Description
`client_order_id`	String	External/client order ID (added for refunds)

9. StoreCreditIssued

Triggered when: Store credit is issued to a customer

Attributes

Same as GiftcardIssued

10. LoyaltyCardIssued

Triggered when: Loyalty card is issued to a customer

Attributes

Same as GiftcardIssued, with these differences:

Attribute	Type	Description
`balance`	Integer	Integer value (not rounded down) for loyalty points
`card_pin`	N/A	Not included for loyalty cards

11. GiftcardExpirationReminder

Triggered when: Reminder sent before gift card expires

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`card_number`	String	Gift card number
`card_id`	String	Internal card ID
`original_value`	Decimal	Original card value (rounded down)
`balance`	Decimal	Current balance (rounded down)
`currency`	String	Currency symbol
`expiration_date`	String	Card expiration date (formatted, "Never" if no expiration)
`company_name`	String	Store name
`store_name`	String	Store name
`giftcard_theme_url`	String	URL to gift card theme image
`barcode_url`	String	URL to card barcode image
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`campaign_id`	String	Gift card campaign ID
`activity_type`	String	Transaction activity type

12. StoreCreditReminder

Triggered when: Reminder about available store credit

Attributes

Same as GiftcardExpirationReminder

13. LoyaltyCardReminder

Triggered when: Reminder about available loyalty points

Attributes

Same as GiftcardExpirationReminder, with one exception:

Attribute	Type	Description
`balance`	Integer	Integer value (not rounded down) for loyalty points

14. CouponExpirationReminder

Triggered when: Reminder sent before coupon expires

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`coupon_code`	String	Coupon code
`coupon_title`	String	Coupon title/name
`coupon_type`	String	Type of coupon (e.g., PERCENTAGE, FIXED_AMOUNT)
`value`	String	Coupon value with currency formatting
`currency`	String	Currency symbol
`expiration_date`	String	Coupon expiration date (formatted, "Never" if no expiration)
`company_name`	String	Store name
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL

15. CouponIssued

Triggered when: A new coupon is issued to a customer

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`coupon_title`	String	Coupon title/name
`coupon_code`	String	Coupon code
`coupon_id`	String	Coupon reference number
`coupon_rule_id`	String	Coupon rule reference number
`currency`	String	Currency symbol
`coupon_type`	String	Type of coupon (e.g., PERCENTAGE, FIXED_AMOUNT)
`value`	String	Coupon value with currency formatting
`min_quantity`	Integer	Minimum quantity required to use coupon
`min_subtotal`	Decimal	Minimum subtotal required to use coupon
`max_usage_per_customer`	Integer	Maximum times customer can use this coupon
`expiration_date`	String	Coupon expiration date (formatted, "Never" if no expiration)
`greeting_message`	String	Transaction description/message
`company_name`	String	Store name
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`activity_type`	String	Transaction activity type

16. MembershipIssued

Triggered when: A new membership is issued

Attributes

Attribute	Type	Description
`membership_name`	String	Name of the membership tier
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`card_number`	String	Membership card number
`expiration_date`	String	Membership expiration date (formatted, "Never" if no expiration)
`company_name`	String	Store name
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`client_order_id`	String	External/client order ID
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL

17-24. Membership Transaction Events

The following membership events share the same attributes as MembershipIssued:

Event Name	Triggered When
`MembershipExpired`	A membership expires
`MembershipExtendExpiry`	A membership expiration date is extended
`MembershipActivated`	A membership is activated
`MembershipDeactivated`	A membership is deactivated
`MembershipRenewed`	A membership is renewed
`MembershipCancelled`	A membership is cancelled
`MembershipPaused`	A membership is paused
`MembershipResume`	A paused membership is resumed

25. MembershipChanged

Triggered when: A membership is changed to a different tier

Attributes

Same as MembershipIssued, plus:

Attribute	Type	Description
`new_membership_name`	String	Name of the new membership tier
`old_membership_name`	String	Name of the previous membership tier

26-28. VIP Tier Events

Events: TierUpgraded, TierDowngraded, TierChanged

Triggered when: Customer's VIP tier changes

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`current_tier_name`	String	Name of current/new tier
`current_tier_description`	String	Description of current/new tier
`previous_tier_name`	String	Name of previous tier
`previous_tier_description`	String	Description of previous tier
`tier_change_type`	String	Type of change (e.g., "TIER_UPGRADED", "TIER_DOWNGRADED", "TIER_CHANGED")
`tier_locked_until`	String	Date until which tier is locked (formatted, "Never" if not locked)
`transaction_date`	String	Date of tier change (formatted)
`company_name`	String	Store name
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's current VIP tier name

29. PartnerOrderPlaced

Triggered when: A partner places a bulk order

Attributes

Attribute	Type	Description
`partner_email`	String	Partner account email
`account_name`	String	Partner account name
`store_name`	String	Store name
`order_id`	String	Order ID
`delivery_mode`	String	Delivery method/card type
`currency_code`	String	Currency code (short form)
`total_quantity`	Integer	Total number of cards ordered
`card_value`	Decimal	Value per card (rounded down)
`subtotal`	Decimal	Order subtotal (rounded down)
`discount`	String	Discount percentage (formatted as string with %)
`shipping_fee`	Decimal	Shipping fee (rounded down)
`order_total`	Decimal	Total order amount (rounded down)

30. PartnerGiftcardIssued

Triggered when: A gift card from a partner order is issued

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`card_number`	String	Gift card number
`card_pin`	String	Gift card PIN
`card_id`	String	Internal card ID
`original_value`	Decimal	Original card value (rounded down)
`balance`	Decimal	Current balance (rounded down)
`amount`	Decimal	Transaction amount (rounded down)
`currency`	String	Currency symbol
`expiration_date`	String	Card expiration date (formatted, "Never" if no expiration)
`greeting_message`	String	Transaction description/message
`company_name`	String	Store name
`store_name`	String	Store name
`giftcard_theme_url`	String	URL to gift card theme image
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier
`google_pass_url`	String	Google Wallet URL
`apple_pass_url`	String	Apple Wallet URL
`campaign_id`	String	Gift card campaign ID
`activity_type`	String	Transaction activity type

31. ReferralCreated

Triggered when: A customer creates a referral

Attributes

Attribute	Type	Description
`customer_email`	String	Advocate's email
`customer_phone`	String	Advocate's phone
`customer_name`	String	Advocate's name
`customer_first_name`	String	Advocate's first name
`customer_last_name`	String	Advocate's last name
`referral_code`	String	Unique referral code
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Advocate's loyalty points
`store_credit_balance`	Decimal	Advocate's store credit
`vip_tier`	String	Advocate's VIP tier

32. ReferralAcceptedAdvocate

Triggered when: A referral is accepted (notification to advocate)

Attributes

Attribute	Type	Description
`customer_email`	String	Advocate's email
`customer_phone`	String	Advocate's phone
`customer_name`	String	Advocate's name
`customer_first_name`	String	Advocate's first name
`customer_last_name`	String	Advocate's last name
`friend_name`	String	Friend's name (person who accepted)
`referral_code`	String	Referral code used
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Advocate's loyalty points
`store_credit_balance`	Decimal	Advocate's store credit
`vip_tier`	String	Advocate's VIP tier

33. ReferralAcceptedFriend

Triggered when: A referral is accepted (notification to friend)

Attributes

Attribute	Type	Description
`customer_email`	String	Friend's email
`customer_phone`	String	Friend's phone
`customer_name`	String	Friend's name
`customer_first_name`	String	Friend's first name
`customer_last_name`	String	Friend's last name
`advocate_name`	String	Advocate's name (person who referred)
`coupon_code`	String	Coupon code issued to friend
`coupon_value`	String	Coupon value (formatted with currency)
`expiration_date`	String	Coupon expiration date (formatted, "Never" if no expiration)
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Friend's loyalty points
`store_credit_balance`	Decimal	Friend's store credit
`vip_tier`	String	Friend's VIP tier

34. ReferralCompletedAdvocate

Triggered when: A referral is completed (notification to advocate)

Attributes

Attribute	Type	Description
`customer_email`	String	Advocate's email
`customer_phone`	String	Advocate's phone
`customer_name`	String	Advocate's name
`customer_first_name`	String	Advocate's first name
`customer_last_name`	String	Advocate's last name
`friend_name`	String	Friend's name
`referral_code`	String	Referral code
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Advocate's loyalty points
`store_credit_balance`	Decimal	Advocate's store credit
`vip_tier`	String	Advocate's VIP tier

35. ReferralCompletedFriend

Triggered when: A referral is completed (notification to friend)

Attributes

Attribute	Type	Description
`customer_email`	String	Friend's email
`customer_phone`	String	Friend's phone
`customer_name`	String	Friend's name
`customer_first_name`	String	Friend's first name
`customer_last_name`	String	Friend's last name
`advocate_name`	String	Advocate's name
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Friend's loyalty points
`store_credit_balance`	Decimal	Friend's store credit
`vip_tier`	String	Friend's VIP tier

36. ReferralCancelled

Triggered when: A referral is cancelled

Attributes

Attribute	Type	Description
`customer_email`	String	Friend's email
`customer_phone`	String	Friend's phone
`customer_name`	String	Friend's name
`customer_first_name`	String	Friend's first name
`customer_last_name`	String	Friend's last name
`store_name`	String	Store name
`company_name`	String	Store name
`loyalty_card_balance`	Integer	Friend's loyalty points
`store_credit_balance`	Decimal	Friend's store credit
`vip_tier`	String	Friend's VIP tier

37. OrderConfirmation

Triggered when: An order is confirmed

Attributes

Attribute	Type	Description
`customer_email`	String	Customer's email
`customer_phone`	String	Customer's phone
`customer_name`	String	Customer's name
`customer_first_name`	String	Customer's first name
`customer_last_name`	String	Customer's last name
`order_id`	String	Order ID
`order_key`	String	Order key
`payment_source`	String	Payment source/method
`created_at`	String	Order creation timestamp (formatted)
`client_payment_id`	String	Client payment reference number
`shipping_address`	Object	Shipping address object
`billing_address`	Object	Billing address object
`currency_symbol`	String	Currency symbol
`currency_code`	String	Currency code (short form)
`order_total`	String	Total order amount (formatted with currency symbol)
`shipping_fee`	String	Shipping fee (formatted with currency symbol)
`subtotal`	String	Order subtotal (formatted with currency symbol)
`total_quantity`	Integer	Total quantity of items
`client_order_id`	String	External/client order ID
`order_date`	String	Order date (formatted)
`company_name`	String	Store name
`store_name`	String	Store name
`loyalty_card_balance`	Integer	Customer's loyalty points
`store_credit_balance`	Decimal	Customer's store credit
`vip_tier`	String	Customer's VIP tier

38. ShippingConfirmation

Triggered when: An order shipment is confirmed

Attributes

Same as OrderConfirmation

Platform-Specific Notes

Omnisend

If expiration_date equals "Never", it is set to null in the payload

Klaviyo

No platform-specific modifications to the base payload