Event Details Sent to External Integrations
Nector sends events to the marketing and messaging tools you connect, such as Klaviyo, MoEngage, WebEngage, CleverTap, Interakt, etc. Each event tells your tool that something happened to a customer, for example "earned points", "got a coupon" or "moved to a new VIP tier". It also carries properties with the details: how many points, which coupon, the customer's new balance, and so on.
This article lists every event Nector sends, when it is sent, and what each property means. Use it to build flows, segments and message templates.
How to read the event data
1. Event name. The event name is the event topic, for example walletreward_create. If you set an event prefix in Nector, it is added in front with a dot: a prefix of nector gives nector.walletreward_create.
2. Every event has two groups of properties:
- Common properties describe your business and the customer. They are on every event (see Common properties).
- Event specific properties describe the record that triggered the event, such as the coupon, order or points reward. They depend on the event.
3. Empty values are sent as an empty string "". A value that is missing, null or false arrives as "". A 0 stays 0. So when a yes/no property shows "", treat it as No.
4. Custom properties. Any custom properties you add to the event integration in Nector are also included in every event.
All events at a glance
Events are split into two groups. Start with the essential events. Use the others when you need them.
Essential events
These cover the messages most stores send: points rewarded or redeemed, a new coupon, points about to expire, a referral reward, a review request, a VIP tier change, credits about to expire, an abandoned checkout reminder, and a membership change.
Event topic | When it is sent | Properties |
|---|---|---|
| Loyalty points are rewarded to the customer. Can also be triggered when points are redeemed, imported, reverted, adjusted or expired. | |
| A coupon is issued to the customer, for example after redeeming points or as a referral reward. | |
| Reminder: some of the customer's points are about to expire. | |
| Sent to the referrer when the referral is completed and they receive their reward. | |
| Review request, sent after an order so the customer can leave a review. | |
| The customer moves up or down a VIP tier. | |
| Reminder: some of the customer's credits are about to expire. | |
| Reminder: the customer has an abandoned checkout. It may include a recovery coupon. | |
| The customer's paid or VIP membership changes. |
Other events
Event topic | When it is sent | Properties |
|---|---|---|
| Reminder: the customer has unused points. | |
| Reminder: the customer has a coupon they haven't used. | |
| A customer submits a product review. | |
| A review is updated, for example approved or featured. | |
| A coupon is updated, for example when it is used. | |
| A new customer is created on the platform. | |
| A customer's points balance, credit balance, VIP tier, membership, birthday, anniversary, etc. changes. | |
| Credits are rewarded to the customer. Can also be triggered when credits are redeemed, imported, reverted, adjusted or expired. | |
| An order is placed by a customer. | |
| An order changes, for example it is paid, delivered, cancelled or refunded. | |
| A customer asks a product question. | |
| A product question is updated, for example answered. | |
| A VIP tier change record is updated. | |
| A membership change record is updated. | |
| A customer leaves a checkout without paying. | |
| An abandoned checkout is updated. | |
| A referral is created: a friend arrived through a customer's referral link or code. | |
| A referral is updated, for example completed. | |
| Sent to the referred friend when they receive their referral reward. | |
| Reminder to the referred friend, who has not yet completed the referral (has not placed a qualifying order). | |
| A points reward or redemption is updated. | |
| A credit reward or redemption is updated. |
Who is the "customer" in an event? The common
user_*properties always describe the customer who receives the event. In referral events that is the person named in the event list above: the referrer or the referred friend.
Common properties sent on every event
Business
Property | Description | Sample value |
|---|---|---|
| Your business name, as set in Nector. |
|
| What you call your loyalty points. |
|
| Symbol for your store currency. |
|
| Your store currency. |
|
| Link to your website. | |
| Link to your website that also opens the Nector rewards widget when the page loads. |
Customer
Property | Description | Sample value |
|---|---|---|
| Customer name. |
|
| Customer email. | |
| Mobile number with a leading | |
| Mobile number with the country code and no |
|
| Customer's country code. |
|
| Birthday, as day and month ( |
|
| Full date of birth ( |
|
| Anniversary, as day and month ( |
|
| Full anniversary date ( |
|
|
|
|
| Customer tags synced from your store: lowercase and comma-separated. |
|
| The customer's ID on your store platform, with the platform as a prefix. |
|
| Tags Nector manages for this customer, for example a custom earning rate or a block on referrals. |
|
Loyalty
Property | Description | Sample value |
|---|---|---|
| The customer's current points balance. |
|
| The customer's current points balance. Use |
|
| The customer's current credit balance. |
|
| The customer's current VIP tier. Empty if they have no tier. |
|
| The customer's current membership. Empty if they have none. |
|
| Total amount the customer has saved through your loyalty program. |
|
| Number of friends this customer has referred successfully. |
|
Referral
Property | Description | Sample value |
|---|---|---|
| The customer's own referral code, to share with friends. |
|
| The customer's referral link (recommended). | |
| The older format of the referral link. Use | |
| Despite the name, this is the referral link, the same value as |
Event properties
The properties below come in addition to the common properties above.
Customer events
Events: lead_create, lead_update
These properties hold the same values as the matching common properties. For example, name is the same as user_name, email is the same as user_email, available is the same as user_available_balance and tier is the same as user_tier. The one exception is mobile: it is the number as stored on the customer's profile, so it may not include the country code, while user_mobile always includes it.
Property | Description | Sample value |
|---|---|---|
| Customer name. |
|
| Customer email. | |
| Customer mobile, as stored. |
|
| Customer's country code. |
|
| Current points balance. |
|
| Current credit balance. |
|
| Current VIP tier. |
|
| Current membership. |
|
| The customer's own referral code. |
|
|
|
|
|
|
|
|
|
|
| Birthday ( |
|
| Anniversary ( |
|
|
|
|
| Customer tags synced from your store. |
|
| The customer's ID on your store platform. |
|
| Whether the email address has been checked: |
|
| Tags Nector manages for this customer. |
|
|
|
|
| When the customer was added to Nector. |
|
| When the customer was last updated. |
|
Points rewarded events
Events: walletreward_create, wallettransaction_update, unusedwalletcoinrequest_create
These events are sent whenever a customer's points change: mainly when points are rewarded, but also when they are redeemed, imported, reverted, adjusted or expired. Use operation and type to tell them apart. For example, to message customers only when they earn points, filter on operation = cr and type = reward.
Property | Description | Sample value |
|---|---|---|
| Number of points added or taken away. |
|
|
|
|
| Why the points changed: |
|
| Short description, as shown to the customer. |
|
| Longer description, if any. |
|
| The customer's points balance right after this change. |
|
| Date the points count from. Points expiry is calculated from this date. |
|
| Name of the earning rule that rewarded these points. |
|
| Fixed identifier of that earning rule. |
|
| Customer name. If the name is missing, a partly hidden email or mobile. |
|
| How many unused-points reminders have been sent for these points. |
|
| When the last unused-points reminder was sent. |
|
| When the points were rewarded (or redeemed, etc.) or last updated. |
|
Credits rewarded events
Events: creditwalletreward_create, creditwallettransaction_update
Credits work like points but hold a money value. These events are sent whenever a customer's credits change: mainly when credits are rewarded, but also when they are redeemed, imported, reverted, adjusted or expired. Use operation and type to tell them apart. For example, to message customers only when they earn credits, filter on operation = cr and type = reward. The customer's current credit balance is also in the common property user_available_credit_balance.
Property | Description | Sample value |
|---|---|---|
| Credit amount added or taken away. |
|
|
|
|
| Why the credits changed: |
|
| Short description, as shown to the customer. |
|
| Longer description, if any. |
|
| The customer's credit balance right after this change. |
|
| Date the credits count from. Credit expiry is calculated from this date. |
|
| Name of the earning rule that rewarded these credits. |
|
| Fixed identifier of that earning rule. |
|
| Customer name. If the name is missing, a partly hidden email or mobile. |
|
| When the credits were rewarded (or redeemed, etc.) or last updated. |
|
Coupon events
Events: coupon_create, coupon_update, unusedcouponrequest_create
Property | Description | Sample value |
|---|---|---|
| The coupon code the customer enters at checkout. |
|
| Coupon name. |
|
| Coupon conditions. |
|
|
|
|
| Size of the discount: a percentage or an amount, depending on |
|
|
|
|
| Minimum cart value needed to use the coupon. Empty if there is no minimum. |
|
| Expiry date in a readable format. |
|
| When the coupon expires. |
|
| Link that opens your store with this coupon already applied. | |
|
|
|
| Number of times the coupon has been used. |
|
| How the coupon was created: |
|
| Platform where the coupon was created. |
|
| Points the customer spent to get this coupon. |
|
| Credits the customer spent to get this coupon. |
|
|
|
|
|
|
|
|
|
|
|
|
|
| The rule that issued the coupon, for example a referral reward. |
|
| Customer name. |
|
| How many unused-coupon reminders have been sent. |
|
| When the last unused-coupon reminder was sent. |
|
| When the coupon was created or last updated. |
|
Order events
Events: order_create, order_update
Property | Description | Sample value |
|---|---|---|
| Order number as shown in your store. |
|
| Order total. |
|
| Total discount on the order. |
|
| Tax on the order. |
|
| Order currency. |
|
| Order status: |
|
| Payment status: |
|
| Delivery status: |
|
|
|
|
| Link to the customer's order status page. | |
| If Nector helped bring in this order, how it did so. For example |
|
| Latest order total after any partial refunds. |
|
| Latest discount amount after any changes. |
|
| Payment gateway used. |
|
| Order tags synced from your store. |
|
| UTM parameters from the visit that led to the order. |
|
| Order ID on your store platform. |
|
| Platform the order came from: |
|
|
|
|
| Points the customer earns for this order. |
|
| Points already given for this order. Can be lower than |
|
| Points the customer redeemed on this order. |
|
| Credits the customer redeemed on this order. |
|
| Amount the customer saved on this order through your loyalty program. |
|
| Same as | |
| Customer name. |
|
| Order currency, as sent by your store. |
|
| When the order was completed or delivered. |
|
| When the order was created on your store platform. |
|
| How many review requests have been sent for this order. |
|
| Shipping city. Other shipping details are also sent as |
|
| When the order was added to Nector or last updated. |
|
Order events also contain many
meta__order_reward_condition__*properties, a copy of the earning rules that applied to the order. They are for internal use and you can ignore them.
Review request event
Event: reviewrequest_create
Sent after an order so the customer can review the products they bought. This event has the same properties as order events, plus the review link:
Property | Description | Sample value |
|---|---|---|
| Link to the page where the customer can review the products in this order. |
|
Review events
Events: review_create, review_update
Property | Description | Sample value |
|---|---|---|
| Star rating from 1 to 5. |
|
| Review text. |
|
| Reviewer name, as shown on the review. |
|
| Product name. |
|
| Link to the product page. | |
|
|
|
|
|
|
|
|
|
| Number of photos attached. |
|
| Number of videos attached. |
|
| Your reply to the review, if any. |
|
| Where the review came from: |
|
| Product ID on your store platform. |
|
| Product handle or URL slug. |
|
| Platform the product is from. |
|
| When the review was posted. |
|
| Points given as a reward for this review, if any. |
|
| Name of the coupon given as a reward for this review, if any. |
|
| When the review was added to Nector or last updated. |
|
Product question events
Events: qna_create, qna_update
Property | Description | Sample value |
|---|---|---|
| The question. |
|
| Your answer. Empty until answered. |
|
| Name of the person who asked. |
|
| Product name. |
|
| Link to the product page. | |
|
|
|
| Product ID on your store platform. |
|
| Product handle or URL slug. |
|
| Platform the product is from. |
|
| When the question was posted. |
|
| When the question was added or last updated. |
|
VIP tier events
Events: viptier_create, viptier_update
Property | Description | Sample value |
|---|---|---|
| The new tier name, formatted for display. |
|
| The customer's new tier (internal name). |
|
|
|
|
| When the customer entered this tier. |
|
| When this tier will expire, if your tiers have an expiry period. |
|
| Customer name. |
|
| When the tier change was recorded or last updated. |
|
Membership events
Events: vipmembership_create, vipmembership_update
Property | Description | Sample value |
|---|---|---|
| The new membership name, formatted for display. |
|
| The customer's new membership (internal name). |
|
|
|
|
| When the customer got this membership. |
|
| When this membership will expire, if memberships have an expiry period. |
|
| Customer name. |
|
| When the membership change was recorded or last updated. |
|
Abandoned checkout events
Events: abandonedcheckout_create, abandonedcheckout_update, abandonedcheckoutrequest_create
Property | Description | Sample value |
|---|---|---|
| Link that takes the customer back to their checkout. | |
| Same link, with the recovery coupon (if any) already applied. | |
| Checkout total. |
|
| Cart value before discounts. |
|
| Discount applied. |
|
| Tax. |
|
| Checkout currency. |
|
| Contact details entered at checkout. |
|
| When the checkout was completed, if the customer came back and paid. |
|
| How many abandoned-checkout reminders have been sent. |
|
|
|
|
| Customer name. |
|
| When the checkout was recorded or last updated. |
|
If a recovery coupon was created for the checkout, the event also contains the coupon reward properties (coupon_name, coupon_value and so on).
Referral events
Events: referral_create, referral_update, refereenotify_create, referrernotify_create, incompletereferralrequest_create
In referral properties, referred_by_* is the referrer (the customer who shared their link or code) and referred_to_* is the referred friend.
Property | Description | Sample value |
|---|---|---|
|
|
|
| Referrer's name. |
|
| Referred friend's name. |
|
| How the friend was referred: |
|
| Name of the coupon given to the referrer. |
|
| Points given to the referrer (when the referrer's reward is points). |
|
| Name of the coupon given to the referred friend. |
|
| Points given to the referred friend (when the friend's reward is points). |
|
| Value of the friend's order that completed the referral. |
|
| How many incomplete-referral reminders have been sent. |
|
| When the last incomplete-referral reminder was sent. |
|
| When the referral was created or last updated. |
|
Friend's order properties
These are sent when the referral is linked to an order placed by the referred friend.
Property | Description | Sample value |
|---|---|---|
| Order number as shown in your store. |
|
| Order total. |
|
| Discount on the order. |
|
| Tax on the order. |
|
| Order currency. |
|
| Order status (same values as in order events). |
|
| Payment status. |
|
| Delivery status. |
|
| When the order was placed, in a readable format. |
|
| Link to the order status page. |
Reward properties (coupon or points)
These are sent in refereenotify_create, referrernotify_create, incompletereferralrequest_create and abandonedcheckoutrequest_create. They describe the reward the customer received, and only one of the two sets is sent.
If the reward is a coupon:
Property | Description | Sample value |
|---|---|---|
| The coupon code. |
|
| Coupon name. |
|
| Coupon conditions. |
|
|
|
|
| Size of the discount. |
|
|
|
|
| Minimum cart value needed. Empty if there is no minimum. |
|
| Expiry date in a readable format. |
|
| When the coupon expires. |
|
| Link that opens your store with the coupon applied. |
If the reward is points:
Property | Description | Sample value |
|---|---|---|
| Points given. |
|
| Title of the points reward. |
|
| Description, if any. |
|
| Points balance right after the reward. |
|
|
|
|
| Type of points change (see points rewarded events). |
|
Points expiry reminder event
Event: coinexpirynotify_create
Property | Description | Sample value |
|---|---|---|
| Number of points about to expire. |
|
| Date the points expire, in a readable format. |
|
| Approximate date the points expire (reminder date plus one month, week or day). |
|
| How far ahead this reminder is: |
|
| When this reminder was created. |
|
Credit expiry reminder event
Event: creditexpirynotify_create
Property | Description | Sample value |
|---|---|---|
| Credit amount about to expire. |
|
| Date the credits expire, in a readable format. |
|
| Approximate date the credits expire (reminder date plus one month, week or day). |
|
| How far ahead this reminder is: |
|
| When this reminder was created. |
|
Updated on: 15/10/2026
Thank you!
