Skip to main content

Klaviyo integration: Data reference

CS avatar
Written by CS
Updated over a week ago

This guide details every data point the OMNI Loyalty app sends to Klaviyo. It is divided into two sections:

  1. Profile Properties: Data stored on the customer's profile (e.g., current point balance).

  2. Events: Actions that trigger specific flows (e.g., "Points Added").


1. Customer Profile Properties

These properties describe the current "state" of a member. They are updated automatically whenever a relevant event occurs. Use these for segmentation (e.g., "Show me all Gold Tier members").

  • email (String): Customer email address.

  • wv_point_balance (Number): The customer's current total points.

  • wv_point_balance_updated_at (Date): Timestamp of the last balance change.

  • wv_member_tier (String): The ID of their current tier.

  • wv_member_tier_name (String): Tier name (Default Language).

  • wv_member_tier_name_en (String): Tier name (English).

  • wv_member_tier_name_zh-tw (String): Tier name (Traditional Chinese).

  • wv_member_tier_name_zh-cn (String): Tier name (Simplified Chinese).

  • wv_member_tier_expired_at (String): Date the current tier expires.

  • wv_member_tier_updated_at (Date): Timestamp of the last tier change.

  • wv_member_status (String): Member status (e.g., Active).

  • wv_member_status_updated_at (Date): Timestamp of the last status change.

  • wv_birth_month (String): Birth month in ISO 8601 format.

  • wv_birth_month_updated_at (Date): Timestamp when birth month was last updated.


2. Point Activity Events

These events fire whenever a customer's point balance changes.

Points Added

Event Name: wv/points/added

Trigger: When points are added to the customer

Updates Profile Properties:

  • wv_point_balance

  • wv_point_balance_updated_at

Event Properties:

  • value (Number): Amount of points added.

  • source (String): Source of the points addition.

  • note (String): Additional notes.

Points Subtracted

Event Name: wv/points/subtracted

Trigger: When points are subtracted from the customer

Updates Profile Properties:

  • wv_point_balance

  • wv_point_balance_updated_at

Event Properties:

  • value (Number): Amount of points subtracted.

  • source (String): Source of the points subtraction.

  • note (String): Additional notes.

Points Expiring

Event Name: wv/points/expiring

Trigger: Fires a set number of days before points expire, by default 30 days.

Updates Profile Properties:

  • None (only email is set).

Event Properties:

  • value (Number): Amount of points expiring.

  • points_expired_at (Date): When the points will expire.

  • notice_period_in_days (Number): Number of days before expiration.

Points Expired

Event Name: wv/points/expired

Trigger: When points transactions have expired

Updates Profile Properties:

  • wv_point_balance

  • wv_point_balance_updated_at

Event Properties:

  • value (Number): Amount of points expired.


3. Reward Events

Use these events to send coupon codes immediately after a redemption.

Reward Issued

Event Name: wv/reward/issued

Trigger: When a new reward is issued to the customer

Updates Profile Properties:

  • wv_point_balance

  • wv_point_balance_updated_at

Event Properties:

  • points_used (Number): Points used for the reward.

  • type (String): Type of reward.

  • source (String): Source of reward issuance.

  • reward_expired_at (Date/Null): Reward expiration date.

  • reward_discount_code (String): Discount code for the reward.

  • reward_name (String): Reward name (default locale).

  • reward_name_en (String): Reward name (English).

  • reward_name_zh-tw (String): Reward name (Traditional Chinese).

  • reward_name_zh-cn (String): Reward name (Simplified Chinese).

  • note (String): Additional notes.

  • reward_id (String/Null): Reward public ID.

  • image_url (String): Image URL for the reward.

  • credit_amount (Number): Credit amount (0 for non-store credit).

  • credit_currency (String): Currency code (empty for non-store credit).


4. Membership & Tier Events

These events track the customer's lifecycle and status changes.

Member Activated

Event Name: wv/member/activated

Trigger: When a customer joins the program.

Updates Profile Properties:

  • wv_point_balance (+ updated_at)

  • wv_member_tier (+ updated_at & expired_at)

  • wv_member_tier_name (all locales: default, en, zh-tw, zh-cn)

  • wv_member_status (+ updated_at)

  • wv_birth_month (+ updated_at)

Event Properties:

  • tier_bonus_points_granted (Number): Bonus points granted for tier.

  • welcome_bonus_points_granted (Number): Welcome bonus points granted.

  • welcome_reward_image_url (String): Welcome reward image URL.

  • welcome_reward_discount_code (String): Welcome reward discount code.

  • welcome_reward_expired_at (Date/Null): Welcome reward expiration date.

  • welcome_reward_name (String): Welcome reward name (default locale).

  • welcome_reward_name_en (String): Welcome reward name (English).

  • welcome_reward_name_zh-tw (String): Welcome reward name (Traditional Chinese).

  • welcome_reward_name_zh-cn (String): Welcome reward name (Simplified Chinese).

Member Account Registered

Event Name: wv/member/account_registered

Triggers when a customer completes legacy account registration

Updates Profile Properties:

  • wv_point_balance (+ updated_at)

  • wv_member_tier (+ updated_at & expired_at)

  • wv_member_tier_name (all locales: default, en, zh-tw, zh-cn)

  • wv_member_status (+ updated_at)

  • wv_birth_month (+ updated_at)

Event Properties:

  • Same as Member Activated (see above).

Member Profile Updated

Event Name: wv/member/profile_updated

Triggers when specific customer profiles fields are updated

Updates Profile Properties:

  • wv_point_balance (+ updated_at)

  • wv_member_tier (+ updated_at & expired_at)

  • wv_member_tier_name (all locales: default, en, zh-tw, zh-cn)

  • wv_member_status (+ updated_at)

  • wv_birth_month (+ updated_at)

Event Properties:

  • type (String): Type of profile update.

Customer Merged

Event Name: wv/customer/merged

Triggers when another customer profile has been merged to this customer profile

Updates Profile Properties:

  • wv_point_balance (+ updated_at)

  • wv_member_tier (+ updated_at & expired_at)

  • wv_member_tier_name (all locales: default, en, zh-tw, zh-cn)

  • wv_member_status (+ updated_at)

  • wv_birth_month (+ updated_at)

Event Properties:

  • None (Empty Object).

Tier Updated

Event Name: wv/tier/updated

Trigger: When a member moves up or down a tier or when there is an update to their tier status (such as extending their current tier).

Updates Profile Properties:

  • wv_member_tier (+ updated_at & expired_at)

  • wv_member_tier_name (all locales: default, en, zh-tw, zh-cn)

Event Properties:

  • tier_bonus_points_granted (Number): Bonus points granted for new tier.

  • new_tier (String): New tier name (default locale).

  • new_tier_en (String): New tier name (English).

  • new_tier_zh-tw (String): New tier name (Traditional Chinese).

  • new_tier_zh-cn (String): New tier name (Simplified Chinese).

  • previous_tier (String): Previous tier name (default locale).

  • previous_tier_en (String): Previous tier name (English).

  • previous_tier_zh-tw (String): Previous tier name (Traditional Chinese).

  • previous_tier_zh-cn (String): Previous tier name (Simplified Chinese).

  • type (String): Type of tier update.


5. Birthday Events

Events related to capturing or celebrating birthdays.

Birth Month Captured

Event Name: wv/birth_month/captured

Trigger: When the birthday month is collected for the customer

Updates Profile Properties:

  • wv_birth_month

  • wv_birth_month_updated_at

Event Properties:

  • None (Empty Object).

Birth Month Entered

Event Name: wv/birth_month/entered

Trigger: On the first possible day of the birthday month for the customer

Updates Profile Properties:

  • None (only email is set).

Event Properties:

  • birth_month (Number): Birth month (1-12).

  • birthday_bonus_points_granted (Number): Bonus points granted for birthday.

  • reward_discount_code (String): Birthday reward discount code.

  • reward_expired_at (Date/Null): Birthday reward expiration date.


Technical Appendix

  • Unique IDs: All events include a unique_id (derived from event.eventId) to prevent duplicate event processing.

  • Timestamps: All events include a time field marking the exact moment the event occurred.

Did this answer your question?