Schemas

Here you can find a list and description of the data structures for Customers, Events and Contexts.

Customer

The customer data structure includes a list of the fields related to customer properties, such as first name and last name, gender, date or birth or time zone.

Each event has a different data structure, with its own fields. For example, the “completed order” event (eg. customer purchased goods in the ecommerce store) has fields such as: orderId, storeCode, paymentMethod, amount, and products. If an email campaign is sent to a customer, you will find in the “campaign sent” event the campaignSubject, campaignId, campaignName and other relevant information.

Contexts

Each context has a different data structure, with its own fields. For example, the “ECOMMERCE” context has properties such as the store info and the client info.

CUSTOMER

Customer payload schema. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Enum
id	Id	string	false	false	false	true	false	auto-on-create
enabled	Enabled	boolean	false	false	false	false	false
intId	Int Id	integer	false	false	false	true	false	auto-on-create
nodeId	Node Id	string	false	false	true	true	false	final
externalId	External Id	string	false	true	false	true	false
extra	Extra	string	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
base		object	false	true	false	false	false
extended	Extended	object	false	true	false	false	false
consents		object	false	true	false	false	false
tags		object	false	true	false	false	false
sourceInfo		object	false	true	false	false	false
version	Version	integer	false	true	false	true	false	auto-on-update
deleted	Deleted state	integer	false	false	false	true	false	auto-on-create		-1, 0, 1

base

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format	Pattern	Enum
pictureUrl	Picture	string	false	true	false	false	true	url
title	Title	string	false	true	false	false	true
prefix	Prefix	string	false	true	false	false	true
firstName	First name	string	false	true	false	true	true
lastName	Last name	string	false	true	false	true	true
middleName	Middle name	string	false	true	false	false	true
gender	Gender	string	false	true	false	true	true
dob	dob	string	false	true	false	true	true	date
locale	Locale	string	false	true	false	true	true		^[a-z]{2}(_([a-zA-Z]{2}){1,2})?_[A-Z]{2}$
timezone		string	false	true	false	false	false			null, Africa/Abidjan, Africa/Accra, Africa/Algiers, Africa/Bissau, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/El_Aaiun, Africa/Johannesburg, Africa/Khartoum, Africa/Lagos, Africa/Maputo, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Fort_Nelson, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/La_Paz, America/Lima, America/Los_Angeles, America/Maceio, America/Managua, America/Manaus, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Johns, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Simferopol, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zaporozhye, Europe/Zurich, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Reunion, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis
contacts	Contacts	object	false	true	false	false	false
address	Address	object	false	true	false	false	false
credential	Credential	object	false	true	false	false	false
educations	Educations	object	true	false	false	false	false
likes	Likes	object	true	false	false	false	false
socialProfile	Social profile	object	false	true	false	false	false
jobs	Jobs	object	true	false	false	false	false
subscriptions	Subscriptions	object	true	false	false	false	false

contacts

The contact information for the customer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
email	Email	string	false	true	false	true	true	email
fax	Fax number	string	false	true	false	false	true
mobilePhone	Mobile number	string	false	true	false	true	true
phone	Phone number	string	false	true	false	true	true
otherContacts	Other contacts	object	true	false	false	false	false
mobileDevices	Mobile devices	object	true	false	false	false	false

otherContacts

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
name	Name	string	false	true	false	false	false
type	Type	string	false	true	false	false	false	MOBILE, PHONE, EMAIL, FAX, OTHER, null
value	Value	string	false	true	false	false	false

mobileDevices

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
identifier	Identifier	string	false	true	false	false	false
type	Type	string	false	true	false	false	false	IOS, ANDROID, WINDOWS_PHONE, FIREOS, null
appId	App Id	string	false	true	false	false	false
name	Name	string	false	true	false	false	false
notificationService	Notification Service	string	false	true	false	false	false	APN, GCM, WNS, ADM, SNS, null

address

The address details of the customer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	true	true
country	Country	string	false	true	false	true	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	zip	string	false	true	false	true	true
geo	Geographic localization	object	false	true	false	false	false

geo

The geographic location of the customer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
lat	Latitude	number	false	true	false	false	true
lon	Longitude	number	false	true	false	false	true

credential

The customer login credentials

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
password	Password	string	false	true	false	false	true
username	User name	string	false	true	false	false	true

educations

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
id	Id	string	false	false	true	false	false
schoolType	School type	string	false	true	false	false	false	PRIMARY_SCHOOL, SECONDARY_SCHOOL, HIGH_SCHOOL, COLLEGE, OTHER, null
schoolName	School name	string	false	true	false	false	false
schoolConcentration	School concentration	string	false	true	false	false	false
startYear	Start year	integer	false	true	false	false	false
endYear	End year	integer	false	true	false	false	false
isCurrent	Is current	boolean	false	true	false	false	false

likes

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
id	Id	string	false	false	true	false	false
category	Category	string	false	true	false	false	false
name	Name	string	false	true	false	false	false
createdTime	Created time	string	false	true	false	false	false	date-time

socialProfile

The social profiles of the customer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
facebook	Facebook	string	false	true	false	false	true
google	Google plus	string	false	true	false	false	true
instagram	Instagram	string	false	true	false	false	true
linkedin	Linkedin	string	false	true	false	false	true
qzone	Qzone	string	false	true	false	false	true
twitter	Twitter	string	false	true	false	false	true

jobs

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
id	Id	string	false	false	true	false	false
companyIndustry	Company Industry	string	false	true	false	false	false
companyName	Company name	string	false	true	false	false	false
jobTitle	Job title	string	false	true	false	false	false
startDate	Start date	string	false	true	false	false	false	date
endDate	End date	string	false	true	false	false	false	date
isCurrent	Is current	boolean	false	true	false	false	false

subscriptions

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format	Enum
id	Id	string	false	false	true	true	true
type	Type	string	false	true	false	true	true
name	Name	string	false	true	false	true	true
kind	Kind	string	false	true	false	true	true		DIGITAL_MESSAGE, SERVICE, OTHER, null
subscribed	Subscribed	boolean	false	false	true	true	true
startDate	Start date	string	false	true	false	true	true	date-time
endDate	End date	string	false	true	false	true	true	date-time
subscriberId	Subscriber id	string	false	true	false	true	true
registeredAt	Registered at	string	false	true	false	true	true	date-time
updatedAt	Updated at	string	false	true	false	true	true	date-time
subscribeContext	Subscribe context	object	false	true	false	false	false
unsubscribeContext	Unsubscribe context	object	false	true	false	false	false

subscribeContext

The subscribe context information

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
ip	Ip	string	false	true	false	false	true
userAgent	User agent	string	false	true	false	false	true

unsubscribeContext

The unsubscribe context information

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
ip	Ip	string	false	true	false	false	true
userAgent	User agent	string	false	true	false	false	true
campaignId	Campaign id	string	false	true	false	false	true
campaignMessageId	Campaign message id	string	false	true	false	false	true

consents

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
disclaimer	Disclaimer	object	false	true	false	false	false
marketing	Marketing	object	false	true	false	false	false
profiling	Profiling	object	false	true	false	false	false
softSpam	Soft spam	object	false	true	false	false	false
thirdPartyTransfer	Third party transfer	object	false	true	false	false	false

disclaimer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
date	Date	string	false	true	false	true	true		date-time
version	Version	string	false	true	false	true	true

marketing

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
traditional	Traditionals	object	false	true	false	false	false
automatic	Automatic	object	false	true	false	false	false

traditional

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
telephonic		object	false	true	false	false	false
papery		object	false	true	false	false	false

automatic

Name	Type	Array	Nullable	Required	Indexed	FlowEnabled
sms	object	false	true	false	false	false
email	object	false	true	false	false	false
push	object	false	true	false	false	false
im	object	false	true	false	false	false
telephonic	object	false	true	false	false	false

profiling

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
classic		object	false	true	false	false	false
online		object	false	true	false	false	false

softSpam

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
email		object	false	true	false	false	false
papery		object	false	true	false	false	false

thirdPartyTransfer

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
profiling		object	false	true	false	false	false
marketing		object	false	true	false	false	false

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
auto	Auto	string	true	false	false	true	true
manual	Manual	string	true	false	false	true	true

sourceInfo

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
registeredBy	Registered by	string	false	false	false	true	false	auto-on-create
updatedBy	Updated by	string	false	false	false	true	false	auto-on-update

EVENTS

abandonedCart

Customer added product to cart but not completed the order/transaction. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			abandonedCart
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
orderId	Order id	string	false	true	false	true	true
abandonedCartUrl	Abandoned cart url	string	false	true	false	false	true	url
storeCode	Store code	string	false	true	false	true	true
amount	Amount	object	false	true	false	false	false
products	Products	object	true	true	false	false	false
extended	Extended properties	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false

amount

Details of transaction

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
total	Total	number	false	true	false	true	true
revenue	Revenue	number	false	true	false	false	true
shipping	Shipping	number	false	true	false	false	true
tax	Tax	number	false	true	false	false	true
discount	Discount	number	false	true	false	false	true
local	Local	object	false	true	false	false	false

local

Currency local section

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
currency		string	false	true	false	false	false				null, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TMM, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XAG, XAU, XOF, XPD, XPF, XPT, YER, ZAR, ZMK, ZWD
exchangeRate	Exchange rate	number	false	true	false	false	true

products

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format	Enum
discount	Discount	number	false	true	false	true	true
type	Type	string	false	true	false	true	true		null, sale, return
quantity	Quantity	number	false	true	false	true	true
subtotal	Subtotal	number	false	true	false	true	true
price	Price	number	false	true	false	true	true
name	Name	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	true	true
orderLineId	Order line id	integer	false	true	false	true	true
classifications	Classifications	object	true	true	false	false	false
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	true	true
linkUrl	Link url	string	false	true	false	true	true	url
imageUrl	Image url	string	false	true	false	true	true	url
coupon	Coupon	string	false	true	false	true	true
tax	Tax	number	false	true	false	true	true
id	Id	string	false	true	false	true	true
weight	Weight	number	false	true	false	true	true
itemQuantity	Item quantity	number	false	true	false	true	true
unitOfMeasure	Unit of measure	string	false	true	false	true	true
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	true	true
value	Value	string	false	false	true	true	true

abandonedSession

Customer that left current session. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			abandonedSession
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
abandonedSessionUrl	Abandoned session url	string	false	true	false	false	true	url
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

addedCompare

Customer added a product to comparator. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			addedCompare
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
linkUrl	Link url	string	false	true	false	false	true	uri
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

addedProduct

Customer added a product to their shopping cart. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			addedProduct
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
shortDescription	Short description	string	false	true	false	false	true
linkUrl	Link url	string	false	true	false	false	true	uri
imageUrl	Image url	string	false	true	false	false	true	uri
classifications	Classifications	object	true	true	false	false	false
category	Category	string	true	true	false	true	true
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
quantity	Quantity	number	false	true	false	false	true
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
unitOfMeasure	Unit of measure	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

addedReward

The customer acquired a reward. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			addedReward
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
rewardAmount	Reward amount	number	false	false	true	false	true
rewardDescription	Reward description	string	false	true	false	false	true
rewardType	Reward type	string	false	true	false	false	true
rewardTypeId	Reward type id	string	false	false	true	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

addedWishlist

Customer added a product to their wishlist. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			addedWishlist
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
linkUrl	Link url	string	false	true	false	false	true	uri
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

campaignBlacklisted

Customer went to blacklist. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignBlacklisted
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
isWirelessDevice	Is wireless device	integer	false	true	false	false	true
isMobile	Is mobile	integer	false	true	false	false	true
isTablet	Is tablet	integer	false	true	false	false	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignBounced

Notice from an email server that a campaign is undeliverable. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignBounced
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
isWirelessDevice	Is wireless device	integer	false	true	false	false	true
isMobile	Is mobile	integer	false	true	false	false	true
isTablet	Is tablet	integer	false	true	false	false	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignLinkClicked

Customer opened a link in a campaign received. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignLinkClicked
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true		SMS, EMAIL, PUSH, FAX, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
isWirelessDevice	Is wireless device	integer	false	true	false	false	true
isMobile	Is mobile	integer	false	true	false	false	true
isTablet	Is tablet	integer	false	true	false	false	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
linkUrl	Link url	string	false	true	false	false	true	uri
linkId	Link id	string	false	true	false	false	true
linkTags	Link tags	string	true	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignMarkedSpam

Notice from an email server that a campaign is undeliverable. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignMarkedSpam
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
isWirelessDevice	Is wireless device	integer	false	true	false	false	true
isMobile	Is mobile	integer	false	true	false	false	true
isTablet	Is tablet	integer	false	true	false	false	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignOpened

Customer opened a campaign received. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignOpened
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
isWirelessDevice	Is wireless device	integer	false	true	false	false	true
isMobile	Is mobile	integer	false	true	false	false	true
isTablet	Is tablet	integer	false	true	false	false	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignOptinRequested

Customer was sent the optin request. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignOptinRequested
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
listId	List id	string	false	true	false	false	true
listName	List name	string	false	true	false	false	true
subscriberId	Subscriber id	string	false	true	false	true	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, IM, null
channelType	Channel type	string	false	true	false	true	true
invitationChannel	Invitation channel	string	false	true	false	false	true	SMS, EMAIL, PUSH, FAX, IM, null
invitationChannelType	Invitation channel type	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignSent

Customer received a campaign. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignSent
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, IM, null
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
channelType	Channel type	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignSubscribed

Customer subscribed a list. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignSubscribed
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, IM, null
channelType	Channel type	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

campaignUnsubscribed

Customer unsubscribed from a list. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			campaignUnsubscribed
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
subscriberId	Subscriber id	string	false	true	false	true	true
campaignSubject	Campaign subject	string	false	true	false	true	true
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignTags	Campaign tags	string	true	true	false	false	true
channel	Channel	string	false	true	false	true	true	SMS, EMAIL, PUSH, FAX, IM, null
channelType	Channel type	string	false	true	false	true	true
listName	List name	string	false	true	false	false	true
listId	List id	string	false	true	false	false	true
mailDomain	Mail domain	string	false	true	false	false	true
userdbId	User db id	integer	false	true	false	true	true
recipient	Recipient	string	false	true	false	true	true
sendImmediateId	Send immediate id	string	false	true	false	true	true
campaignMessageId	Campaign message id	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

changedSetting

Customer changed a setting on website/app. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			changedSetting
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
setting	Setting	string	false	true	false	false	true	LANGUAGE, TIMEZONE, CURRENCY, EMAIL, PASSWORD, USERNAME, OTHER, null
oldValue	Old value	string	false	true	false	false	true
newValue	New value	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

clickedLink

Customer clicked a link. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			clickedLink
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
path	Path	string	false	true	false	true	true
referer	Referer	string	false	true	false	true	true
search	Search	string	false	true	false	false	true
title	Title	string	false	true	false	false	true
url	Url	string	false	true	false	true	true	uri
linkTags	Link tags	string	true	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

closedTicket

The customer closed a ticket to a customer care. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			closedTicket
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
ticketId	Ticket id	string	false	true	false	false	true
category	Category	string	true	true	false	true	true
subject	Subject	string	false	true	false	false	true
text	Text	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

completedOrder

The customer completed successfully an order/transaction. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			completedOrder
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
orderId	Order id	string	false	true	false	true	true
type	Type	string	false	true	false	true	true	sale, return, sale-return
storeCode	Store code	string	false	true	false	true	true
paymentMethod	Payment method	string	false	true	false	false	true	cash, creditcard, debitcard, paypal, other, null
shippingMethod	Shipping method	string	false	true	false	false	true
amount	Amount	object	false	true	false	false	false
products	Products	object	true	true	false	false	false
extended	Extended properties	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false

amount

Details of transaction

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
total	Total	number	false	true	false	true	true
revenue	Revenue	number	false	true	false	false	true
shipping	Shipping	number	false	true	false	false	true
tax	Tax	number	false	true	false	false	true
discount	Discount	number	false	true	false	false	true
local	Local	object	false	true	false	false	false

local

Currency local section

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
currency		string	false	true	false	false	false				null, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TMM, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XAG, XAU, XOF, XPD, XPF, XPT, YER, ZAR, ZMK, ZWD
exchangeRate	Exchange rate	number	false	true	false	false	true

products

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format	Enum
discount	Discount	number	false	true	false	true	true
type	Type	string	false	true	false	true	true		null, sale, return
quantity	Quantity	number	false	true	false	true	true
subtotal	Subtotal	number	false	true	false	true	true
price	Price	number	false	true	false	true	true
name	Name	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	true	true
orderLineId	Order line id	integer	false	true	false	true	true
classifications	Classifications	object	true	true	false	false	false
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	true	true
linkUrl	Link url	string	false	true	false	true	true	url
imageUrl	Image url	string	false	true	false	true	true	url
coupon	Coupon	string	false	true	false	true	true
tax	Tax	number	false	true	false	true	true
id	Id	string	false	true	false	true	true
weight	Weight	number	false	true	false	true	true
itemQuantity	Item quantity	number	false	true	false	true	true
unitOfMeasure	Unit of measure	string	false	true	false	true	true
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	true	true
value	Value	string	false	false	true	true	true

eventConfirmed

Customer has confirmed the invite for the event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventConfirmed
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventDeclined

Customer has declined the invite for the event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventDeclined
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventEligible

Customer is eligible to be invited at the event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventEligible
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventInvited

Customer was invited at an event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventInvited
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventNoShow

The customer didn't show up at the event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventNoShow
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventNotInvited

Customer was not invited to an event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventNotInvited
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

eventParticipated

Customer has participated to an event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventParticipated
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
checkIn	Check in date	string	false	true	false	false	true	date-time
checkOut	Check out date	string	false	true	false	false	true	date-time
host	Host	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

host

host of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
firstName	First name	string	false	true	false	false	true
lastName	Last name	string	false	true	false	false	true
title	Title	string	false	true	false	false	true
contacts	Contacts	object	false	true	false	false	false

contacts

contacts of the host

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
email	Email	string	false	true	false	false	true	email
phone	Phone	string	false	true	false	false	true
mobilePhone	Mobile phone	string	false	true	false	false	true

eventRegistered

Customer has registered at an event. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			eventRegistered
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
eventId	Event id	string	false	true	false	true	true
eventName	Event name	string	false	true	false	true	true
eventDate	Event date	string	false	true	false	true	true	date-time
eventType	Event type	string	false	true	false	true	true
eventLocation	Event Location	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

eventLocation

The location of the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	The location type	string	false	true	false	false	true	STORE, VENUE, STADIUM, MUSEUM, HEADQUARTERS, PALACE, CLUB, ROOM, OTHER, null
id	Location identifier	string	false	true	false	false	true
name	The location name	string	false	true	false	false	true
address	Address	object	false	true	false	false	false

address

The address details of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	true
city	City	string	false	true	false	false	true
country	Country	string	false	true	false	false	true
province	Province	string	false	true	false	false	true
region	Region	string	false	true	false	false	true
zip	ZIP	string	false	true	false	false	true
geo	Geographic location	object	false	true	false	false	false

formCompiled

Customer compiled a form on the website/app/convention. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			formCompiled
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
formName	Form name	string	false	true	false	false	true
formId	Form id	string	false	true	false	false	true
data	Form data	object	false	true	false	false	false
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

genericActiveEvent

Customer made an active event uncovered. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			genericActiveEvent
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
name	Name	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

genericPassiveEvent

Customer made a passive event uncovered. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			genericPassiveEvent
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
name	Name	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

grantedCoupon

Customer has been granted a coupon. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			grantedCoupon
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
code	Code	string	false	true	false	false	true
type	Type	string	false	true	false	true	true
redeemDate	Redeem date	string	false	true	false	false	true	date-time
startValidityDate	Start validity date	string	false	false	true	false	true	date-time
redemptionDate	Redemption date	string	false	true	false	false	true	date-time
campaignId	Campaign id	string	false	true	false	true	true
campaignName	Campaign name	string	false	true	false	true	true
campaignDescription	Campaign description	string	false	true	false	false	true
status	Status	string	false	true	false	true	true
redeemedAmount	Redeemed amount	number	false	true	false	false	true
totalAmount	Total amount	number	false	false	true	false	true
remainingAmount	Remaining amount	number	false	true	false	false	true
deliveryChannel	Delivery channel	object	false	true	false	false	false
deliveryMedium	Delivery medium	object	false	true	false	false	false
category	Category	string	true	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

deliveryChannel

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
id	Id	string	false	true	false	false	true
description	Description	string	false	true	false	false	true
name	Name	string	false	true	false	false	true

deliveryMedium

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
id	Id	string	false	true	false	false	true
description	Description	string	false	true	false	false	true
name	Name	string	false	true	false	false	true

loggedIn

The customer logged in an app/software/site web. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			loggedIn
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

loggedOut

The customer logged out from an app/software/site web. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			loggedOut
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

openedTicket

The customer opened a ticket to a customer care. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			openedTicket
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
ticketId	Ticket id	string	false	true	false	false	true
category	Category	string	true	true	false	true	true
subject	Subject	string	false	true	false	false	true
text	Text	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

orderShipped

The company shipped the products present in the order. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			orderShipped
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
orderId	Order id	string	false	true	false	true	true
type	Type	string	false	true	false	true	true
carrier	Type	string	false	true	false	false	true
trackingCode	Tracking code	string	false	true	false	false	true
trackingUrl	Tracking URL	string	false	true	false	false	true	url
weight	Weight	number	false	true	false	false	true
packages	Packages	integer	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

removedCompare

Customer removed a product to comparator. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			removedCompare
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
linkUrl	Link url	string	false	true	false	false	true	uri
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

removedProduct

Customer removed a product from their shopping cart. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			removedProduct
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
shortDescription	Short description	string	false	true	false	false	true
linkUrl	Link url	string	false	true	false	false	true	uri
imageUrl	Image url	string	false	true	false	false	true	uri
classifications	Classifications	object	true	true	false	false	false
category	Category	string	true	true	false	true	true
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
quantity	Quantity	number	false	true	false	false	true
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
unitOfMeasure	Unit of measure	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

removedReward

The customer lost a reward. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			removedReward
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
rewardAmount	Reward amount	number	false	false	true	false	true
rewardDescription	Reward description	string	false	true	false	false	true
rewardType	Reward type	string	false	true	false	false	true
rewardTypeId	Reward type id	string	false	false	true	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

removedWishlist

Customer removed a product from the wish list. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			removedWishlist
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
linkUrl	Link url	string	false	true	false	false	true	uri
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

repliedTicket

The Agent of customer care replied to ticket from a customer. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			repliedTicket
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
ticketId	Ticket id	string	false	true	false	false	true
category	Category	string	true	true	false	true	true
subject	Subject	string	false	true	false	false	true
text	Text	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

reviewedProduct

Customer reviewed a product. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			reviewedProduct
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
linkUrl	Link url	string	false	true	false	false	true	uri
rating	Rating	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

searched

Customer searched on website/app. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			searched
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
keyword	Keyword	string	false	true	false	false	true
resultCount	Result count	integer	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

serviceSubscribed

Customer subscribed to a service subscription. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			serviceSubscribed
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
subscriberId	Subscriber id	string	false	true	false	true	true
serviceId	Service id	string	false	true	false	true	true
serviceName	Service name	string	false	true	false	true	true
serviceType	Service type	string	false	true	false	true	true
startDate	Start date	string	false	true	false	true	true	date-time
endDate	End date	string	false	true	false	true	true	date-time
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

serviceUnsubscribed

Customer unsubscribed from a service subscription. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			serviceUnsubscribed
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
subscriberId	Subscriber id	string	false	true	false	true	true
serviceId	Service id	string	false	true	false	true	true
serviceName	Service name	string	false	true	false	true	true
serviceType	Service type	string	false	true	false	true	true
startDate	Start date	string	false	true	false	true	true	date-time
endDate	End date	string	false	true	false	true	true	date-time
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

surveyCompiled

Customer compiled a survey. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			surveyCompiled
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
respondentId	Respondent id	string	false	false	true	true	true
surveyName	Survey name	string	false	true	false	false	true
surveyId	Survey id	string	false	false	true	true	true
startDate	Start date	string	false	true	false	true	true	date-time
endDate	End date	string	false	true	false	true	true	date-time
completed	Completed	boolean	false	true	false	true	true
languageCode	Language code	string	false	true	false	false	true
os	Os	number	false	true	false	false	true
ca	Ca	number	false	true	false	false	true
nps	Nps	number	false	true	false	false	true
itb	Itb	number	false	true	false	false	true
qr	Qr	number	false	true	false	false	true
qrs	Qrs	string	false	true	false	false	true
followupRequest	Followup Request	string	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

viewedPage

Customer viewed a page on website/app. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			viewedPage
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
path	Path	string	false	true	false	true	true
referer	Referer	string	false	true	false	true	true
search	Search	string	false	true	false	false	true
title	Title	string	false	true	false	false	true
url	Url	string	false	true	false	true	true	uri
vendor	Vendor	string	false	true	false	false	true
duration	Duration	number	false	true	false	false	true
sessionId	Session Id	string	false	true	false	false	true
pageCategories	Page categories	string	true	true	false	true	true
pageTags	Page tags	string	true	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

viewedProduct

Customer viewed a product details. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			viewedProduct
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
category	Category	string	true	true	false	true	true
shortDescription	Short description	string	false	true	false	false	true
classifications	Classifications	object	true	true	false	false	false
id	Id	string	false	true	false	true	true
sku	Sku	string	false	true	false	true	true
vendor	Vendor	string	false	true	false	false	true
name	Name	string	false	true	false	false	true
price	Price	number	false	true	false	true	true
imageUrl	Image url	string	false	true	false	false	true	uri
linkUrl	Link url	string	false	true	false	false	true	uri
weight	Weight	number	false	true	false	false	true
itemQuantity	Item quantity	number	false	true	false	false	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

classifications

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
key	Key	string	false	false	true	false	true
value	Value	string	false	false	true	false	true

viewedProductCategory

Customer viewed a product category list. Payload must not exceed 64kB.

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
id	Id	string	false	false	false	true	false	auto-on-create		^.+$
type	Type	string	false	false	true	true	false	final			viewedProductCategory
customerId	Customer id	string	false	false	false	true	false	final		^.+$
bringBackProperties	Bring back properties	object	false	true	false	false	false	final
context	Event context	string	false	false	true	true	false				CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date	Date	string	false	false	false	true	true		date-time
contextInfo	Context info	object	false	true	false	false	false
tracking	Tracking	object	false	true	false	false	false
registeredAt	Registered at	string	false	false	false	true	false	auto-on-create	date-time
updatedAt	Updated at	string	false	true	false	true	false	auto-on-update	date-time
origin	Event origin	string	false	false	false	false	false	auto-on-create			NATIVE, DUPLICATE
version	Version	integer	false	true	false	true	false	auto-on-update
properties	Properties	object	false	false	true	false	false

properties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
category	Category	string	false	true	false	true	true
extraProperties	Extra properties	object	false	true	false	false	false
extended	Extended properties	object	false	true	false	false	false

CONTEXTS

CONTACT_CENTER

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

client

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
userAgent	User agent	string	false	true	false	false	false
ip	Ip	string	false	true	false	false	false	ipv4
localization	Localization	object	false	true	false	false	false

localization

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
city	City	string	false	true	false	false	false
country	Country	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
province	Province	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false

DIGITAL_CAMPAIGN

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

client

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
userAgent	User agent	string	false	true	false	false	false
ip	Ip	string	false	true	false	false	false	ipv4
localization	Localization	object	false	true	false	false	false

localization

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
city	City	string	false	true	false	false	false
country	Country	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
province	Province	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false

ECOMMERCE

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
client	Client	object	false	true	false	false	false
store	Store	object	false	true	false	false	false
user	User	object	false	true	false	false	false

IOT

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

MOBILE

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
client	Client	object	false	true	false	false	false
device	Device	object	false	true	false	false	false
user	User	object	false	true	false	false	false

client

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
userAgent	User agent	string	false	true	false	false	false
ip	Ip	string	false	true	false	false	false	ipv4
localization	Localization	object	false	true	false	false	false

localization

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
city	City	string	false	true	false	false	false
country	Country	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
province	Province	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false

device

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
bundleIdentifier	Bundle identifier	string	false	true	false	false	false
versionNumber	Version number	string	false	true	false	false	false
buildNumber	Build number	string	false	true	false	false	false
identifierForVendor	Identifier for vendor	string	false	true	false	false	false
systemVersion	System version	string	false	true	false	false	false
model	Model	string	false	true	false	false	false
deviceVendor	Device vendor	string	false	true	false	false	false
locale	Locale	string	false	true	false	false	false
language	Language	string	false	true	false	false	false

OTHER

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

RETAIL

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
client	Client	object	false	true	false	false	false
salesAssistant	Sales assistant	object	false	true	false	false	false
store	Store	object	false	true	false	false	false
user	User	object	false	true	false	false	false

salesAssistant

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
id	Id	string	false	true	false	true	false
firstName	First name	string	false	true	false	true	false
lastName	Last name	string	false	true	false	true	false
contacts	Contacts	object	false	true	false	false	false

contacts

The contact information for the sales assistant

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
email	Email	string	false	true	false	false	false	email
mobilePhone	Mobile phone	string	false	true	false	false	false
phone	Phone	string	false	true	false	false	false

SOCIAL

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

client

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
userAgent	User agent	string	false	true	false	false	false
ip	Ip	string	false	true	false	false	false	ipv4
localization	Localization	object	false	true	false	false	false

localization

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
city	City	string	false	true	false	false	false
country	Country	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
province	Province	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false

WEB

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
client	Client	object	false	true	false	false	false
user	User	object	false	true	false	false	false

MODELS

client

The client information refer to the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
userAgent	User agent	string	false	true	false	false	false
ip	Ip	string	false	true	false	false	false	ipv4
localization	Localization	object	false	true	false	false	false

localization

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
street	Street	string	false	true	false	false	false
city	City	string	false	true	false	false	false
country	Country	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
province	Province	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false

eventbringbackproperties

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
type	Type	string	false	false	true	true	false	SESSION_ID, EXTERNAL_ID
value	Value	string	false	false	true	true	false
nodeId	Node id	string	false	false	true	true	false

geographiclocation

The geographic coordinate of the location

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
lat	Latitude	number	false	true	false	false	true
lon	Longitude	number	false	true	false	false	true

indexed-consent

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
status	Status	boolean	false	true	false	true	true
limitation	Limitation	boolean	false	true	false	false	true
objection	Objection	boolean	false	true	false	false	true

not-indexed-consent

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
status	Status	boolean	false	true	false	false	true
limitation	Limitation	boolean	false	true	false	false	true
objection	Objection	boolean	false	true	false	false	true

store

The store information refer to the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Enum
id	Id	string	false	true	false	false	false
type	Type	string	false	true	false	false	false	null, AIRPORT, ECOMMERCE, FLAGSHIP, FREE-STANDING, MALL, OUTLET, RESORT, SIS, WAREHOUSE, NOT-DEFINED
name	Name	string	false	true	false	true	false
street	Street	string	false	true	false	false	false
city	City	string	false	true	false	true	false
country	Country	string	false	true	false	true	false
province	Province	string	false	true	false	false	false
region	Region	string	false	true	false	false	false
zip	ZIP	string	false	true	false	false	false
geo	Geographic location	object	false	true	false	false	false
website	Website	string	false	true	false	false	false

tracking

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Kind	Format	Pattern	Enum
ga	Google Analytics	object	false	false	false	false	false

ga

Tracking with Google Analytics parameters

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
utm_source	Campaign Source	string	false	false	false	false	false
utm_medium	Campaign Medium	string	false	false	false	false	false
utm_term	Campaign Term	string	false	false	false	false	false
utm_content	Campaign Content	string	false	false	false	false	false
utm_campaign	Campaign Name	string	false	false	false	false	false

user

The user information refer to the event

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled
id	Identifier	string	false	true	false	false	false
externalId	External identifier	string	false	true	false	true	false
username	Username	string	false	true	false	false	false
firstName	First name	string	false	true	false	false	false
lastName	Last name	string	false	true	false	false	false
contacts	Contact details	object	false	true	false	false	false

contacts

The contact information for the user

Name	Label	Type	Array	Nullable	Required	Indexed	FlowEnabled	Format
email	Email	string	false	true	false	false	false	email
mobilePhone	Mobile number	string	false	true	false	false	false
phone	Phone number	string	false	true	false	false	false

Schemas

Customer

Events

Contexts

CUSTOMER

base

contacts

otherContacts

mobileDevices

address

geo

credential

educations

likes

socialProfile

jobs

subscriptions

subscribeContext

unsubscribeContext

consents

disclaimer

marketing

traditional

automatic

profiling

softSpam

thirdPartyTransfer

tags

sourceInfo

EVENTS

abandonedCart

properties

amount

local

products

classifications

abandonedSession

properties

addedCompare

properties

classifications

addedProduct

properties

classifications

addedReward

properties

addedWishlist

properties

classifications

campaignBlacklisted

properties

campaignBounced

properties

campaignLinkClicked

properties

campaignMarkedSpam

properties

campaignOpened

properties

campaignOptinRequested

properties

campaignSent

properties

campaignSubscribed

properties

campaignUnsubscribed

properties

changedSetting

properties

clickedLink

properties

closedTicket

properties

completedOrder

properties

amount

local

products

classifications

eventConfirmed