Nector Events

Various Events Supported

Data Sent On Each Event

Common Data sent on all events:

{
	business_name: "name of the business",
	business_uri: "website url of the business",
	nector_business_uri: "website url of the business",
	business_coin_name: "coin name",
	business_currency_code: "currency code",
	business_currency_symbol: "currency symbol",
	user_customer_id: "user's customer id on host platform",
	user_name: "user's name",
	user_email: "user's email",
	user_mobile: "user's mobile",
	user_tier: "user's tier",
	user_type: "user's type",
	user_referral_code: "referral code of the user",
	user_referred_by_referral_code: "referral code of the customer who referred this customer",
	user_referral_link: "referral link of the customer",
	user_new_referral_link: "referral link of the customer",
	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",
	user_full_dob: "dob of the user in DD-MM-YYYY format",
	user_gender: "user's gender",
	user_country: "user's country",
	user_transaction_amount: "total transaction amount of the user (number)",
	user_transaction_count: "total number of orders placed by the user (number)",
	user_discount_amount: "total discount amount of the user (number)",
	user_discount_count: "total number of orders placed by the user which had a discount(number)",
	user_aov: "user's average order value (number)"
}

Data sent on lead_create and lead_update:

{
	entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
	referral_code: '2nfcdqo46x',
	customer_id: 'shopify-7029064106277',
	referred_by_referral_code: '',
	name: 'Ayush Shukla',
	available: 0,
	tier: '',
	type: 'member',
	classification: '',
	transaction_amount: '',
	transaction_count: '',
	discount_amount: '',
	discount_count: '',
	last_transaction: '',
	accept_email: true,
	accept_mobile: true,
	accept_smartdiscountapply: '',
	aov: '',
	dob: '',
	full_dob: '',
	gender: '',
	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',
	version: 0
}

Data sent on coupon_create and coupon_update, unusedcouponrequest_create:

{
	version: 1,
	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: '19544060264741::1428793491749',
	reference_coupon_source: 'shopify',
	name: '2% Off coupon',
	description: 'Minimum cart amount of ₹499',
	type: 'manual_redeem',
	value: 'coupon_code_here',
	fiat_class: 'percent',
	fiat_value: 2,
	fiat_target: 'cart',
	minimumcart_amount: 499,
	'meta.order_id': '',
	'meta.lead_name': 'Ayush Shukla',
	'meta.coin_spent': 100,
	'meta.fiat_class': 'percent',
	'meta.fiat_value': 2,
	'meta.fiat_target': 'cart',
	'meta.category_ids': '',
	'meta.reference_id': '19544060264741::1428793491749',
	'meta.reference_type': 'shopify',
	'meta.customer_selection': 'all',
	'meta.minimumcart_amount': 499,
	'meta.unusedcouponrequest_count': 0,
	'meta.unusedcouponrequest_sentat': '',
	status: 'issued',
	redirect_link: 'https://nector-dev-store-1.myshopify.com/discount/couponcode?utm_source=nector&utm_medium=email&utm_campaign=transactional',
	expire: '2023-06-02T06:40:33.470Z',
	updated_at: '2023-05-18T06:40:34.898Z',
	created_at: '2023-05-18T06:40:33.472Z',
	formatted_expire: 'June 2nd 2023, 6:40:33 am'
}

Data send on walletreward_create, wallettrasaction_update, unusedwalletcoinrequest_create

{
	version: 0,
	entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
	lead_id: '19c794f5-5ba6-4bf9-b30b-8666ae71d324',
	activity_id: '',
	title: '',
	description: '',
	amount: 1,
	closing_balance: 345693,
	consolidated_cr: 3458710,
	consolidated_dr: 3113017,
	hash: '98f49c894265d162dd8d2e1dbee0fffe9fc4445d',
	'meta.lead_name': 'Ayush Shukla',
	'meta.unusedwalletcoinrequest_count': 0,
	'meta.unusedwalletcoinrequest_sentat': '',
	operation: 'cr',
	type: 'reward',
	status: 'success',
	updated_at: '2023-05-18T06:37:57.506Z',
	created_at: '2023-05-18T06:37:57.506Z'
}

Data sent on review_create, review_update

{
	version: 0,
	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-1.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',
	'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',
	reply_to: ''
}

Data sent on order_create, order_update

{
	version: 0,
	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',
	hash: '85461dd8fbc4f6825259ba39234faa4d22f43c27a3e759974f4b8253213cc492',
	status: 'pending',
	financial_status: 'paid',
	delivery_status: 'pending',
	'meta.name': '#1028',
	'meta.lead_name': 'Ayush Shukla',
	'meta.coin_spent': 100,
	'meta.coin_reward': 0,
	'meta.is_rewarded': '',
	'meta.landing_url': '/',
	'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',
	'meta.referring_url': '',
	'meta.reference_order_id': '5372084388133',
	'meta.reviewrequest_count': 0,
	'meta.reviewrequest_sentat': '',
	'meta.reference_order_source': 'shopify',
	updated_at: '2023-05-26T07:49:06.277Z',
	created_at: '2023-05-26T07:49:06.277Z'
}

Data sent on reviewrequest_create

{
	version: 0,
	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',
	hash: '85461dd8fbc4f6825259ba39234faa4d22f43c27a3e759974f4b8253213cc492',
	status: 'pending',
	financial_status: 'paid',
	delivery_status: 'pending',
	'meta.name': '#1028',
	'meta.lead_name': 'Ayush Shukla',
	'meta.coin_spent': 100,
	'meta.coin_reward': 0,
	'meta.is_rewarded': '',
	'meta.landing_url': '/',
	'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',
	'meta.referring_url': '',
	'meta.reference_order_id': '5372084388133',
	'meta.reviewrequest_count': 0,
	'meta.reviewrequest_sentat': '',
	'meta.reference_order_source': 'shopify',
	updated_at: '2023-05-26T07:49:06.277Z',
	created_at: '2023-05-26T07:49:06.277Z'
	order_review_link: "link to write review"
}

Data sent on incompletereferralrequest_create:

{
	entity_id: '449ebf4f-f3e2-471a-a21f-47d8e148f259',
	order_id: '',
	referral_mode: 'link',
	referred_by_name: 'Yashas',
	referred_by_lead_id: 'be887215-a5e1-4adb-89d7-0a0821c9d3b5',
	referred_to_name: '',
	referred_to_lead_id: '4f685476-167e-474a-ac52-63ec94ef3914',
	'meta.incompletereferralrequest_count': 0,
	'meta.incompletereferralrequest_sentat': '',
	status: 'pending',
	created_at: '2023-04-26T11:23:07.692Z',
	updated_at: '2023-04-26T11:23:07.692Z',
	version: 0
}

Data sent on coinexpirynotify_create:

{
	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"
}

Data sent on refereenotify_create:

{
	version: 1,
	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: '19544060264741::1428793491749',
	reference_coupon_source: 'shopify',
	name: '2% Off coupon',
	description: 'Minimum cart amount of ₹499',
	class: 'self',
	type: 'private',
	value: 'coupon_code_here',
	fiat_class: 'percent',
	fiat_value: 2,
	fiat_target: 'cart',
	minimumcart_amount: 499,
	usage_limit_per_lead: '',
	usage_limit: 1,
	'meta.order_id': '',
	'meta.lead_name': 'Ayush Shukla',
	'meta.coin_spent': 100,
	'meta.fiat_class': 'percent',
	'meta.fiat_value': 2,
	'meta.fiat_target': 'cart',
	'meta.category_ids': '',
	'meta.reference_id': '19544060264741::1428793491749',
	'meta.reference_type': 'shopify',
	'meta.customer_selection': 'all',
	'meta.minimumcart_amount': 499,
	'meta.unusedcouponrequest_count': 0,
	'meta.unusedcouponrequest_sentat': '',
	status: 'issued',
	source: 'nector',
	redirect_link: 'https://nector-dev-store-1.myshopify.com/discount/couponcode?utm_source=nector&utm_medium=email&utm_campaign=transactional',
	expire: '2023-06-02T06:40:33.470Z',
	updated_at: '2023-05-18T06:40:34.898Z',
	created_at: '2023-05-18T06:40:33.472Z',
	formatted_expire: 'June 2nd 2023, 6:40:33 am',
  referred_by_name: '',
  referred_to_name: ''
}