Event Details Sent to External Integrations
This article assumes you have read and enabled the events, please refer this article for more info: https://nector.crisp.help/en/article/events
Some of the common events fired from nector
When customer is created or updated - lead_create and lead_update (View event properties)
When coupon is created or updated - coupon_create and coupon_update (View event properties)
When order is created or updated - order_create and order_update (View event properties)
When wallet transaction is created or updated - walletreward_create and wallettrasaction_update (View event properties)
When review is created or updated - review_create and review_update (View event properties)
A few other events fired from nector
When review request is being sent after the order is fulfilled - reviewrequest_create (View event properties)
When incomplete referral reminder is being sent to the referred friend - incompletereferralrequest_create (View event properties)
When unused coupon reminder is being sent - unusedcouponrequest_create
When unused coin reminder is being sent - unusedwalletcoinrequest_create
When coin expiry reminder is being sent - coinexpirynotify_create (View event properties)
When the referee has to be notified about their referral discount - refereenotify_create (View event properties)
When the referral is completed and referred friend has to be notified about it - referrernotify_create (View event properties)
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
You might receive more properties in the event data payload than listed below
Various events on nector
Some of the common events fired from nector
When customer is created or updated - lead_create and lead_update (View event properties)
When coupon is created or updated - coupon_create and coupon_update (View event properties)
When order is created or updated - order_create and order_update (View event properties)
When wallet transaction is created or updated - walletreward_create and wallettrasaction_update (View event properties)
When review is created or updated - review_create and review_update (View event properties)
A few other events fired from nector
When review request is being sent after the order is fulfilled - reviewrequest_create (View event properties)
When incomplete referral reminder is being sent to the referred friend - incompletereferralrequest_create (View event properties)
When unused coupon reminder is being sent - unusedcouponrequest_create
When unused coin reminder is being sent - unusedwalletcoinrequest_create
When coin expiry reminder is being sent - coinexpirynotify_create (View event properties)
When the referee has to be notified about their referral discount - refereenotify_create (View event properties)
When the referral is completed and referred friend has to be notified about it - referrernotify_create (View event properties)
Common event data sent on every event
You might receive more properties in the event data payload than listed below
business_name: "name of the business (string)",
business_uri: "website url of the business (string)",
nector_business_uri: "website url of the business (string)",
business_coin_name: "coin name (string)",
business_currency_code: "currency code (string)",
business_currency_symbol: "currency symbol (string)",
user_customer_id: "user's customer id on host platform (string)",
user_name: "user's name (string)",
user_email: "user's email (string)",
user_mobile: "user's mobile (string)",
user_tier: "user's tier (string)",
user_referral_code: "referral code of the user (string)",
user_referral_coupon_code: "referral coupon code of the user (string)",
user_referral_link: "referral link of the customer (string)",
user_new_referral_link: "referral link of the customer (string)",
user_available_balance: "coin balance of the user (number)",
user_balance: "coin balance of the user (number)",
user_dob: "dob of the user in DD-MM format (string)",
user_full_dob: "dob of the user in DD-MM-YYYY format (string)",
user_country: "user's country (string)",
user_transaction_amount: "total order amount (number)"
Extra event data specific to lead_create, lead_update
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
referral_code: '2nfcdqo46x',
customer_id: 'shopify-7029064106277',
referred_by_referral_code: '',
name: 'Ayush Shukla',
available: 0,
tier: '',
transaction_amount: '',
last_transaction: '',
accept_email: true,
accept_mobile: true,
accept_smartdiscountapply: '',
dob: '',
full_dob: '',
mid: '',
mobile: '',
country: '',
eid: '206f22037f5bbea617f616fdfe3f643874c6254863af7efed7c08ad75069a4e5',
email: 'ayush+fri26may@nector.io',
email_status: 'pending',
is_freezed: '',
created_at: '2023-05-26T07:44:03.862Z',
updated_at: '2023-05-26T07:44:03.862Z'
Extra event data specific to coupon_create, coupon_update, and unusedcouponrequest_create
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
lead_id: '19c794f5-5ba6-4bf9-b30b-8666ae71d324',
activity_id: '',
offer_id: 'd652a88e-2317-40ea-8369-9fe8463a7d3d',
reference_coupon_id: '40ea40ea::40ea40ea',
reference_coupon_source: 'shopify',
name: '2% Off coupon',
description: 'Minimum cart amount of ₹499',
type: 'manual_redeem',
value: 'TWOOFFVERYGOOD',
fiat_class: 'percent',
fiat_value: 2,
fiat_target: 'cart',
minimumcart_amount: 499,
meta__lead_name: 'Ayush Shukla',
status: 'issued',
redirect_link: 'https://nector-dev-store-99.myshopify.com/discount/TWOOFFVERYGOOD?utm_source=nector&utm_medium=email&utm_campaign=transactional',
expire: '2023-06-02T06:40:33.470Z',
formatted_expire: 'June 2nd 2023, 6:40:33 am',
updated_at: '2023-05-18T06:40:34.898Z',
created_at: '2023-05-18T06:40:33.472Z'
Extra event data specific to walletreward_create, wallettrasaction_update, and unusedwalletcoinrequest_create
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
lead_id: '19c794f5-5ba6-4bf9-b30b-8666ae71d324',
activity_id: '',
title: 'Test Reward',
description: '',
amount: 1,
closing_balance: 1,
consolidated_cr: 1,
consolidated_dr: 0,
hash: '98f49c894265d162dd8d2e1dbee0fffe9fc4445d',
meta__lead_name: 'Ayush Shukla',
operation: 'cr',
type: 'reward',
status: 'success',
updated_at: '2023-05-18T06:37:57.506Z',
created_at: '2023-05-18T06:37:57.506Z'
Extra event data specific to review_create, review_update
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
lead_id: 'd9058911-9300-4f3f-b2a4-e35bc1896d02',
order_id: '',
activity_id: '',
reference_product_name: 'The Multi-location Snowboard',
reference_product_source: 'shopify',
reference_product_id: '8198530236709',
reference_product_redirect_link: 'https://nector-dev-store-99.myshopify.com/products/the-multi-location-snowboard',
reference_review_source: '',
reference_review_id: '',
type: 'review',
name: 'Testing it',
rating: 5,
title: 'Tester Bro',
description: 'Tester Bro',
reply_to: '',
meta__coin_reward: 0,
meta__is_rewarded: '',
is_verified: '',
is_approved: true,
is_featured: '',
updated_at: '2023-05-26T07:46:19.936Z',
created_at: '2023-05-26T07:46:19.936Z'
Extra event data specific to order_create, order_update
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
lead_id: '8decb740-15ce-46e9-88c7-60455b8c9340',
reference_order_name: '#1028',
reference_order_id: '5372084388133',
reference_order_source: 'shopify',
activity_id: '',
currency_code: 'inr',
reference_cart_token: 'abae330db82ddbd690280a6bedaa0e71',
fiat_amount: 849.54,
fiat_discount: 10,
fiat_tax: 129.59,
payment_source: 'bogus',
payment_medium: 'direct',
utm_source: '',
utm_medium: '',
utm_campaign: '',
order_driven_by: 'nector_but_code',
couponredeem_driven_by: 'manual_slide',
status: 'pending',
financial_status: 'paid',
delivery_status: 'pending',
meta__lead_name: 'Ayush Shukla',
meta__coin_spent: 100,
meta__coin_reward: 10,
meta__is_rewarded: '',
meta__currency_code: 'inr',
meta__redirect_link: 'https://nector-dev-store-1.myshopify.com/74023928101/orders/6792fa1820a88c90c85fc12339ec7be0/authenticate?key=100a341ee60cf741d98714cca1e245ea&utm_source=nector&utm_medium=email&utm_campaign=transactional',
updated_at: '2023-05-26T07:49:06.277Z',
created_at: '2023-05-26T07:49:06.277Z'
Extra event data specific to reviewrequest_create
You might receive more properties in the event data payload than listed below
entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
lead_id: '8decb740-15ce-46e9-88c7-60455b8c9340',
reference_order_name: '#1028',
reference_order_id: '5372084388133',
reference_order_source: 'shopify',
activity_id: '',
currency_code: 'inr',
reference_cart_token: 'abae330db82ddbd690280a6bedaa0e71',
fiat_amount: 849.54,
fiat_discount: 10,
fiat_tax: 129.59,
payment_source: 'bogus',
payment_medium: 'direct',
utm_source: '',
utm_medium: '',
utm_campaign: '',
order_driven_by: 'nector_but_code',
couponredeem_driven_by: 'manual_slide',
status: 'pending',
financial_status: 'paid',
delivery_status: 'pending',
meta__lead_name: 'Ayush Shukla',
meta__coin_spent: 100,
meta__coin_reward: 10,
meta__is_rewarded: '',
meta__currency_code: 'inr',
meta__redirect_link: 'https://nector-dev-store-1.myshopify.com/74023928101/orders/6792fa1820a88c90c85fc12339ec7be0/authenticate?key=100a341ee60cf741d98714cca1e245ea&utm_source=nector&utm_medium=email&utm_campaign=transactional',
order_review_link: "https://reviewcollect.nector.io?order_id=dbd690280a6",
updated_at: '2023-05-26T07:49:06.277Z',
created_at: '2023-05-26T07:49:06.277Z'
Extra event data specific to refereenotify_create, referrernotify_create, incompletereferralrequest_create
You might receive more properties in the event data payload than listed below
entity_id: "2c1aceb6-7ec7-4246-89d0-25775afcd649",
coupon_id: "",
wallettransaction_id: "",
order_id: "d3a2cf6b-b1bb-4aa7-9984-e52de1d34c9f",
referral_mode: "link",
referred_by_name: "Yashas",
referred_by_lead_id: "d273a765-3bfa-424e-bfd1-69ebccf69b2c",
referred_by_eid: "a6a47613b6c9db37330de53789926289aaad5d116b330806fb50bf05b0053907",
referred_by_mid: "ba68488520b137878f5a6925ea88b8c367dc27f52ed6c40d17dc8d1072cb0ec3",
referred_to_name: "yashas reddy",
referred_to_lead_id: "8a9cc08a-38e0-42c7-8b0b-f7cd65f9c01a",
referred_to_eid: "7e6a686fa8600f546d02e7425f6a8a597c90b6df6d7191205ba9266af2215da0",
referred_to_mid: "c28d821b2454d8be4deb4350d8f2105983bff5d10b8318e4cd20cfdcd711d0bc",
meta__referred_by_coupon_id: "30cc65df-fdb9-4e25-b6a4-63f82454d457",
meta__referred_to_coupon_id: "35e55f4b-3d8f-463b-ac14-9c8a4dc22424",
meta__incompletereferralrequest_count: 0,
meta__incompletereferralrequest_sentat: "",
meta__referred_by_wallettransaction_id: "",
meta__referred_to_wallettransaction_id: "",
status: "completed",
created_at: "2024-01-09T13:25:14.323Z",
updated_at: "2024-01-09T13:27:50.896Z",
version: 2,
// if the referrer reward is wallet coins, below properties will be present
wallettransaction_title: "Referral Reward",
wallettransaction_description: "",
wallettransaction_amount: 500,
wallettransaction_closing_balance: 31546,
// if the referrer reward is a coupon, below properties will be present
coupon_name: "₹200 Off coupon",
coupon_description: "No minimum cart amount required",
coupon_value: "necpri8a5hzqlomidas",
coupon_fiat_value: 200,
coupon_fiat_target: "cart",
coupon_fiat_class: "amount",
coupon_minimumcart_amount: "",
coupon_formatted_expire: "January 24th 2024, 1:27:50 pm",
coupon_expire: "2024-01-24T13:27:50.397Z",
coupon_redirect_link: "https://nector-dev-store-2.myshopify.com/discount/necpri8a5hzqlomidas?utm_source=nector&utm_medium=event&utm_campaign=transactional"
Extra event data specific to coinexpirynotify_create
You might receive more properties in the event data payload than listed below
wallet_expiry_unit: "month", // values: month, week, day
wallet_expiry_amount: 500,
wallet_expiry_notify_generated_on: "2023-04-26T11:23:07.692Z",
wallet_expiry_estimated_on: "2023-04-26T11:23:07.692Z",
wallet_expiry_formatted_estimated_on: "June 2nd 2023, 6:40:33 am"
Updated on: 26/07/2024