Skip to main content

Omnisend Customer Properties & Events

Written by Kris James

Events

Each event can be turned on or off in Integrations > Omnisend.

Store credit mode. If your loyalty program runs on store credit instead of points, Points Awarded, Points Pending and Points Expiry Soon are replaced by store credit events. See Store credit mode events below.


Points Awarded

Fired when a customer earns points through purchases, actions, or other earning rules.

Contact: Customer's email

Property

Type

Description

Points Awarded

number

Number of points earned

Earning Rule

string

Name of the earning rule (or "Manual")

Status

string

Status of the earning (e.g. APPROVED)

Order Number

string (optional)

Shopify order number, if points were earned from a purchase

Bonus Campaign

string (optional)

Name of the multiplier bonus campaign that boosted this order

Bonus Multiplier

number (optional)

The campaign multiplier, e.g. 2 for double points

Bonus Points

number (optional)

The extra points the campaign added. Points Awarded already includes them.

The three Bonus properties are only included when a multiplier bonus campaign applied to the order. Tiered bonus campaigns send their own Bonus Points Awarded event instead.


Points Pending

Fired when a customer earns points that are not yet in their balance because the earning rule has a waiting period (e.g. purchase points held until the refund window closes). When the points are later approved, a separate Points Awarded event will fire.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Points Awarded

number

Number of points that will be awarded once approved

Earning Rule

string

Name of the earning rule (or "Manual")

Status

string

Always PENDING

Order Number

string (optional)

Shopify order number, if points were earned from a purchase


Bonus Points Awarded

Flat bonus points from a tiered bonus campaign.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Bonus Points

number

Number of bonus points awarded

Campaign Name

string

Name of the bonus campaign

Qualifying Spend

number

The order amount that qualified for the bonus

Spend Threshold

number

The spend threshold that was met

Status

string

APPROVED or PENDING

Order Number

string (optional)

Shopify order number, if the bonus came from a purchase


Reward Redeemed

Fired when a customer redeems their points for a reward or discount.

Contact: Customer's email

Property

Type

Description

Reward Name

string

Name of the reward redeemed

Points Spent

number

Number of points spent (0 if null)

Discount Type

string

Type of discount (e.g. percentage, fixed_amount)

Current Points

number

The customer's points balance after the redemption

Discount Code

string (optional)

The discount code issued for the reward, if one was created


VIP Tier Changed

Fired when a customer moves up or down a VIP tier. Only fires when VIP tiers are enabled on your loyalty program.

Contact: Customer's email

Property

Type

Description

New Tier Name

string

Name of the tier the customer moved to

Previous Tier Name

string (optional)

Name of the previous tier, if applicable


Referral Invite Sent

Fired when an advocate sends a referral email invite to a friend.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Advocate's email

Property

Type

Description

Recipient Email

string

Email address of the invited friend

Campaign Name

string

Name of the referral campaign

Advocate Name

string

Name of the advocate (or "A friend" if not provided)

Subject

string

Email subject line used for the invite

Personal Message

string

Custom message written by the advocate

Referral URL

string

The referral link sent to the friend

Shop Name

string

Name of the Shopify store

Shop Domain

string

Domain of the Shopify store

Channel

string

Always email


Referral Claimed

Fired when a friend claims their referral discount code.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Friend's email

Property

Type

Description

Discount Code

string

The discount code generated for the friend

Discount Type

string

Type of discount (percentage, fixed, free-shipping, free-product)

Discount Amount

number

Discount value (0 if null)

Campaign Name

string

Name of the referral campaign

Reward Name

string

The merchant-defined reward name as set in the campaign reward settings

Advocate Email

string (optional)

Email of the advocate who referred the friend, if known

Advocate Name

string (optional)

Name of the advocate, if known

Shop Name

string

Name of the Shopify store

Shop Domain

string

Domain of the Shopify store


Referral Reward Earned

Fired when an advocate earns their reward after their referred friend completes a purchase.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Advocate's email

Property

Type

Description

Friend Email

string

Email of the friend whose purchase triggered the reward

Discount Code

string

The advocate's reward discount code

Discount Type

string

Type of discount (percentage, fixed, free-shipping, free-product)

Discount Amount

number

Discount value (0 if null)

Reward Name

string

The merchant-defined reward name as set in the campaign reward settings

Campaign Name

string

Name of the referral campaign

Shop Name

string

Name of the Shopify store

Shop Domain

string

Domain of the Shopify store


Points Expiry Soon

Fired when a customer has loyalty points expiring within the next 7 days. This event is triggered once per customer per 7-day window. Points from several earning rules expiring on different days are combined into a single event, so customers never get duplicate reminders.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Points Expiring

number

Total points expiring within the next 7 days (aggregated across all earning rules)

Current Points

number

Customer's current point balance at the time the event fires

Days Until Expiry

number

Days until the earliest expiring points (e.g. 3 means points expire in 3 days)

Customer Name

string

Customer's first name (or "there" if not set)


Gift Reminder

Each reminder includes a unique discount code, created on the first reminder and reused on follow-ups.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Recipient Name

string

Name of the gift recipient (e.g. "Mom")

Relationship

string

How they're related (e.g. "Mother", "Friend")

Occasion Type

string

birthday, anniversary, or other

Occasion Date

string

Date in MM/DD format (e.g. "03/15")

Occasion Month

number

Month as a number (1-12)

Occasion Day

number

Day as a number (1-31)

Days Until Occasion

number

How many days until the occasion (matches the reminder interval)

Reminder Number

number

Which reminder this is (1, 2, or 3) based on the configured order

Discount Code

string

Unique discount code for this recipient

Customer Name

string

Customer's first name (or "there" if not set)

Shop Domain

string

The store's public domain


Birthday

Fired when a customer earns birthday points. Includes the points earned and updated balance so merchants can build birthday automations with reward information.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Customer Name

string

Customer's first name (or "Valued Customer" if not set)

Shop Name

string

Name of the Shopify store

Points Earned

number

Number of birthday points awarded today

Current Points

number

Customer's updated total point balance after the award


Wishlist Reminder

A reminder to a customer about items still on their wishlist. Omnisend supports arrays and nested objects, so you can reference the full Items list in your automation.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire. Wishlist alert provider on the shop must also be set to Omnisend.

Contact: Customer's email

Property

Type

Description

Customer Name

string

Customer's first name (or "there" if not set)

Shop Name

string

Name of the Shopify store

Shop Domain

string

The store's public domain

Items Count

number

Number of items in this reminder

Items

array

Array of item objects (shape below)

Items element shape

Field

Type

Description

ProductId

string

Shopify product ID

ProductName

string | null

Display name of the product

ProductPrice

number | null

Current price

ProductQuantity

number | null

Current stock quantity

ProductBrand

string | null

Product brand

ProductCategory

string | null

Product category

VariantId

string | null

Shopify variant ID

VariantInfo

string | null

Variant title (e.g. "Oat / Medium")

VariantSKU

string | null

Variant SKU

ProductURL

string | null

Public product URL

ImageURL

string | null

Product image URL

ProductTagsList

string[]

Product tags as an array

ProductTags

string

Product tags as a comma-separated string

AddedAt

string

ISO timestamp when the item was added to the wishlist


Wishlist Back in Stock

Same shape as Wishlist Reminder. Omnisend supports arrays and nested objects, so you can reference the full Items list in your automation.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire. Wishlist alert provider on the shop must also be set to Omnisend.

Contact: Customer's email

Property

Type

Description

Customer Name

string

Customer's first name (or "there" if not set)

Shop Name

string

Name of the Shopify store

Shop Domain

string

The store's public domain

Items Count

number

Number of items now back in stock

Items

array

Array of item objects (same shape as Wishlist Reminder)


Wishlist Price Drop

Fired when items on a customer's wishlist drop in price. Omnisend supports arrays and nested objects, so you can reference the full Items list in your automation.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire. Wishlist alert provider on the shop must also be set to Omnisend.

Contact: Customer's email

Property

Type

Description

Customer Name

string

Customer's first name (or "there" if not set)

Shop Name

string

Name of the Shopify store

Shop Domain

string

The store's public domain

Items Count

number

Number of items in this event (the items shown in this notification)

Total Items On Sale

number

Total wishlisted items currently on sale (broader count for CTA copy)

Additional Items Count

number

Total Items On Sale minus Items Count. The "X others" number for subject copy

Items

array

Array of item objects (shape below)

Items element shape

Same fields as the Wishlist Reminder items, plus four price-drop-specific fields:

Field

Type

Description

OldPrice

number

Price before the drop

NewPrice

number

Price after the drop

DropPercent

number

Percentage drop (e.g. 20 for 20% off)

CompareAtPrice

number | null

Shopify compareAtPrice, if set


Mage Welcome

Fired once when a customer creates an account, or a guest becomes a registered customer.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Current Points

number

Customer's current point balance


Cashback Credited

Store-credit cashback awarded.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Cashback Amount

number

Cashback value awarded

Cashback Amount Formatted

string

Cashback value formatted for display (e.g. "$5.50")

Currency

string

Currency code for the cashback amount

Offer Name

string

Name of the cashback offer

Order Number

string

Shopify order number the cashback relates to

Reward Method

string

Always store_credit

Expires At

string (optional)

ISO timestamp when the cashback expires, if applicable


Photo Challenge Approved

Fired when you approve a photo challenge submission. Photo challenges send this event instead of Points Awarded.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Points Awarded

number

Number of points awarded for the challenge

Challenge Name

string

Name of the photo challenge earning rule

Status

string

Always Approved

Submitted Date

string

ISO timestamp when the customer submitted the photo

Approved Date

string

ISO timestamp when you approved it


Photo Challenge Rejected

Fired when you reject a photo challenge submission. No points are involved.

This event is OFF by default. Merchants must enable it in Integrations > Omnisend before it will fire.

Contact: Customer's email

Property

Type

Description

Challenge Name

string

Name of the photo challenge earning rule

Status

string

Always Rejected

Rejection Reason

string

The reason you gave when rejecting the submission

Submitted Date

string

ISO timestamp when the customer submitted the photo

Rejected Date

string

ISO timestamp when you rejected it


Store credit mode events

If your loyalty program runs on store credit instead of points, three events are replaced by store credit versions. They use the same on/off settings as the events they replace. Amounts come as a formatted string (e.g. $5.00) for messages and a plain number (e.g. 5) for filters and splits.

Store Credit Awarded (replaces Points Awarded)

Property

Type

Description

Credit Awarded

string

Store credit earned, formatted in your store currency

Credit Awarded Value

number

The same amount as a plain number

Earning Rule

string

Name of the earning rule (or "Manual")

Status

string

Status of the earning (e.g. APPROVED)

Order Number

string (optional)

Shopify order number, if the credit was earned from a purchase

Bonus Campaign

string (optional)

Name of the multiplier bonus campaign that boosted this order

Bonus Multiplier

number (optional)

The campaign multiplier

Bonus Credit

string (optional)

The extra credit the campaign added, formatted

Bonus Credit Value

number (optional)

The same amount as a plain number

Store Credit Pending (replaces Points Pending)

Property

Type

Description

Credit Awarded

string

Store credit that will be added once approved, formatted

Credit Awarded Value

number

The same amount as a plain number

Earning Rule

string

Name of the earning rule

Status

string

Always PENDING

Order Number

string (optional)

Shopify order number, if the credit was earned from a purchase

Store Credit Expiry Soon (replaces Points Expiry Soon)

Property

Type

Description

Credit Expiring

string

Store credit expiring within the next 7 days, formatted

Credit Expiring Value

number

The same amount as a plain number

Current Credit

string

Customer's current store credit balance, formatted

Current Credit Value

number

The same amount as a plain number

Days Until Expiry

number

Days until the earliest expiring credit

Customer Name

string

Customer's first name (or "there" if not set)

Extra properties on other events

The other events keep their names and gain these store credit properties. Their points-named numbers (for example Points Spent) then hold the amount in cents, so use the store credit properties in your messages.

Property

Type

Description

Credit Spent

string

Reward Redeemed: store credit spent, formatted

Current Credit

string

Reward Redeemed and Birthday: balance after the event, formatted

Credit Awarded

string

Photo Challenge Approved: store credit awarded, formatted

Credit Awarded Value

number

Photo Challenge Approved: the same amount as a plain number

Bonus Credit

string

Bonus Points Awarded: bonus store credit, formatted

Bonus Credit Value

number

Bonus Points Awarded: the same amount as a plain number

Credit Earned

string

Birthday: birthday store credit, formatted

Current Credit

string

Mage Welcome: starting balance, formatted

Current Credit Value

number

Mage Welcome: the same amount as a plain number


Contact Properties

In addition to events, Mage syncs the following properties to each Omnisend contact. Use them in segments, conditional splits and personalization in any workflow or campaign.

When they update. Mage updates a customer's properties whenever their points, tier or rewards change. A customer with no loyalty activity since you connected Omnisend will not have them yet.

Personalization tags. Omnisend stores these names without spaces, for example magePointsBalance for Mage Points Balance. Pick them from Personalization tag > Custom properties, or type the tag yourself, e.g. [[contact.custom_properties.magePointsBalance]].

Points mode

Property

Example Value

Description

Mage Points Balance

100

Customer's current spendable points

Mage Points As Cash Balance

$17.50

Cash value of the customer's current points balance. Only synced when you have an active flexible reward.

Mage Lifetime Points

500

Total points ever earned

Mage Redeemed Points

400

Total points spent on rewards

Mage Vip Tier Name

Gold

Current VIP tier (e.g. Bronze, Silver, Gold)

Mage Next Vip Tier Name

Platinum

The next VIP tier the customer has not reached yet. Empty when the customer is already in the highest tier.

Mage Amount To Next Vip Tier

380

How much more the customer needs in order to reach that next tier. Empty when the customer is already in the highest tier. If your tiers are spend based, the value is rounded to the nearest whole unit of your currency, e.g. 380 = $380.

Mage Secondary Amount To Next Vip Tier

120

Only synced when Advanced VIP Tier Criteria is set. The same countdown for your second tier requirement.

Mage Tertiary Amount To Next Vip Tier

3

Only synced when you have a third tier requirement. The same countdown for that requirement.

Mage Points To Next Reward

250

Growth plan and above. Points still needed to unlock the cheapest reward the customer cannot yet afford. Empty when the customer can already redeem every reward.

Mage Next Reward Name

$10 off

Growth plan and above. Name of that next reward. Empty when the customer can already redeem every reward.

Mage Points Next Expiry Amount

120

Growth plan and above. Points in the customer's next batch due to expire. Empty when nothing is due to expire.

Mage Points Next Expiry Date

2026-09-30T14:00:00.000Z

Growth plan and above. When that batch expires

Mage Date Of Birth

1990-09-17T16:00:00.000Z

Customer's date of birth, if provided

Mage Enrolled Date

2025-01-01T17:00:00.000Z

When the customer joined the loyalty program

Mage Last Synced

2026-05-12T15:56:00.000Z

When Mage last updated this contact

Store credit mode

If your loyalty program runs on store credit instead of points, the balance properties are replaced by the store credit set below. The VIP tier and date properties are the same in both modes.

Property

Example Value

Description

Mage Store Credit Balance

$12.50

Customer's current store credit balance, formatted in your store currency

Mage Store Credit Balance Value

12.5

The same balance as a plain number, for filters and calculations

Mage Lifetime Store Credit

87.5

Total store credit ever earned

Mage Redeemed Store Credit

40

Total store credit spent

Mage Vip Tier Name

Gold

Current VIP tier (e.g. Bronze, Silver, Gold)

Mage Next Vip Tier Name

Platinum

The next VIP tier the customer has not reached yet. Empty when the customer is already in the highest tier.

Mage Amount To Next Vip Tier

380

How much more the customer needs in order to reach that next tier. Empty when the customer is already in the highest tier. If your tiers are spend based, the value is rounded to the nearest whole unit of your currency, e.g. 380 = $380.

Mage Secondary Amount To Next Vip Tier

120

Only synced when Advanced VIP Tier Criteria is set. The same countdown for your second tier requirement.

Mage Tertiary Amount To Next Vip Tier

3

Only synced when you have a third tier requirement. The same countdown for that requirement.

Mage Store Credit Next Expiry Amount

$25.00

Growth plan and above. Store credit in the customer's next batch due to expire, formatted. Empty when nothing is due to expire.

Mage Store Credit Next Expiry Amount Value

25

Growth plan and above. The same amount as a plain number

Mage Store Credit Next Expiry Date

2026-09-30T14:00:00.000Z

Growth plan and above. When that batch expires

Mage Date Of Birth

1990-09-17T16:00:00.000Z

Customer's date of birth, if provided

Mage Enrolled Date

2025-01-01T17:00:00.000Z

When the customer joined the loyalty program

Mage Last Synced

2026-05-12T15:56:00.000Z

When Mage last updated this contact


FAQ

Why don't some contacts have Mage properties yet?

Mage sends a customer's properties the next time their points, tier or rewards change. Customers with no loyalty activity since you connected Omnisend will not have them yet.

Why can't I find a Mage event in the automation trigger list?

Omnisend only lists a custom event after it has fired at least once. Turn the event on in Mage, then use Send Test Event on the Omnisend settings page to send it once.

What unit is "Mage Amount To Next Vip Tier" measured in?

Whatever your VIP tiers are based on: points, amount spent, or number of orders. A value of 380 means 380 more points if your tiers are points based, or 380 more in your store currency if they are spend based. If your program uses more than one tier requirement, the amount reflects your primary requirement.

Why are the next tier properties empty for some customers?

Either VIP tiers are not enabled on your loyalty program, or the customer is already in your highest tier. You can use that second case to target your top tier members with a segment where Mage Next Vip Tier Name has no value.

Did this answer your question?