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.

Events

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 Kind Format Pattern Enum
id Id string false false false true auto-on-create
enabled Enabled boolean false false false false
intId Int Id integer false false false true auto-on-create
nodeId Node Id string false false true true final
externalId External Id string false true false true
extra Extra string false true false false
registeredAt Registered at string false false false true auto-on-create date-time
updatedAt Updated at string false true false true auto-on-update date-time
base object false true false false
extended Extended object false true false false
consents object false true false false
tags object false true false false
sourceInfo object false true false false
version Version integer false true false true auto-on-update
deleted Deleted state integer false false false true auto-on-create -1, 0, 1

base

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
pictureUrl Picture string false true false false url
title Title string false true false false
prefix Prefix string false true false false
firstName First name string false true false true
lastName Last name string false true false true
middleName Middle name string false true false false
gender Gender string false true false true
dob dob string false true false true date
locale Locale string false true false true ^[a-z]{2}(_([a-zA-Z]{2}){1,2})?_[A-Z]{2}$
timezone string false true 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
address Address object false true false false
credential Credential object false true false false
educations Educations object true false false false
likes Likes object true false false false
socialProfile Social profile object false true false false
jobs Jobs object true false false false
subscriptions Subscriptions object true false false false

contacts

The contact information for the customer

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

otherContacts

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

mobileDevices

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

address

The address details of the customer

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

geo

The geographic location of the customer

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

credential

The customer login credentials

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

educations

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

likes

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

socialProfile

The social profiles of the customer

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

jobs

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

subscriptions

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

subscribeContext

The subscribe context information

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

unsubscribeContext

The unsubscribe context information

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

consents

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

disclaimer

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

marketing

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

traditional

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

automatic

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
sms object false true false false
email object false true false false
push object false true false false
im object false true false false
telephonic object false true false false

profiling

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

softSpam

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

thirdPartyTransfer

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

tags

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

sourceInfo

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

properties

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

amount

Details of transaction

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

local

Currency local section

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
currency string false true 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

products

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

classifications

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

abandonedSession

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

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

properties

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
abandonedSessionUrl Abandoned session url string false true false false url
products Products object true true false false
extraProperties Extra properties object false true false false
extended Extended properties object false true false false

products

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
price Price number false true false true
name Name string false true false true
sku Sku string false true false true
vendor Vendor string false true false true
classifications Classifications object true true false false
category Category string true true false true
shortDescription Short description string false true false true
linkUrl Link url string false true false true url
imageUrl Image url string false true false true url
id Id string false true false true
weight Weight number false true false true
itemQuantity Item quantity number false true false true
unitOfMeasure Unit of measure string false true false true

classifications

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

addedCompare

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

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

properties

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

classifications

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

addedProduct

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

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

properties

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

classifications

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

addedReward

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

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

properties

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

addedWishlist

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

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

properties

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

classifications

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

campaignBlacklisted

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

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

properties

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
subscriberId Subscriber id string false true false true
campaignSubject Campaign subject string false true false true
campaignId Campaign id string false true false true
campaignName Campaign name string false true false true
campaignTags Campaign tags string true true false false
channel Channel string false true false true SMS, EMAIL, PUSH, FAX, null
listName List name string false true false false
listId List id string false true false false
mailDomain Mail domain string false true false false
userdbId User db id integer false true false true
recipient Recipient string false true false true
isWirelessDevice Is wireless device integer false true false false
isMobile Is mobile integer false true false false
isTablet Is tablet integer false true false false
sendImmediateId Send immediate id string false true false true
extraProperties Extra properties object false true false false
extended Extended properties object false true 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 Kind Format Pattern Enum
id Id string false false false true auto-on-create ^.+$
type Type string false false true true final campaignBounced
customerId Customer id string false false false true final ^.+$
bringBackProperties Bring back properties object false true false false final
context Event context string false false true true CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date Date string false false false true date-time
contextInfo Context info object false true false false
tracking Tracking object false true false false
registeredAt Registered at string false false false true auto-on-create date-time
updatedAt Updated at string false true false true auto-on-update date-time
origin Event origin string false false false false auto-on-create NATIVE, DUPLICATE
version Version integer false true false true auto-on-update
properties Properties object false false true false

properties

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

campaignLinkClicked

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

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

properties

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
subscriberId Subscriber id string false true false true
campaignSubject Campaign subject string false true false true
campaignId Campaign id string false true false true
campaignName Campaign name string false true false true
campaignTags Campaign tags string true true false false
channel Channel string false true false true SMS, EMAIL, PUSH, FAX, null
listName List name string false true false false
listId List id string false true false false
mailDomain Mail domain string false true false false
userdbId User db id integer false true false true
recipient Recipient string false true false true
isWirelessDevice Is wireless device integer false true false false
isMobile Is mobile integer false true false false
isTablet Is tablet integer false true false false
sendImmediateId Send immediate id string false true false true
linkUrl Link url string false true false false uri
linkId Link id string false true false false
linkTags Link tags string true true false false
extraProperties Extra properties object false true false false
extended Extended properties object false true 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 Kind Format Pattern Enum
id Id string false false false true auto-on-create ^.+$
type Type string false false true true final campaignMarkedSpam
customerId Customer id string false false false true final ^.+$
bringBackProperties Bring back properties object false true false false final
context Event context string false false true true CONTACT_CENTER, WEB, MOBILE, ECOMMERCE, RETAIL, IOT, SOCIAL, DIGITAL_CAMPAIGN, OTHER
date Date string false false false true date-time
contextInfo Context info object false true false false
tracking Tracking object false true false false
registeredAt Registered at string false false false true auto-on-create date-time
updatedAt Updated at string false true false true auto-on-update date-time
origin Event origin string false false false false auto-on-create NATIVE, DUPLICATE
version Version integer false true false true auto-on-update
properties Properties object false false true false

properties

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

campaignOpened

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

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

properties

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

campaignOptinRequested

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

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

properties

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

campaignSent

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

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

properties

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

campaignSubscribed

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

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

properties

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

campaignUnsubscribed

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

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

properties

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

changedSetting

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

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

properties

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

clickedLink

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

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

properties

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

closedTicket

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

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

properties

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

completedOrder

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

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

properties

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
orderId Order id string false true false true
type Type string false true false true sale, return, sale-return
storeCode Store code string false true false true
paymentMethod Payment method string false true false false cash, creditcard, debitcard, paypal, other, null
shippingMethod Shipping method string false true false false
amount Amount object false true false false
registeredAt Registered at string false false false false date-time
updatedAt Updated at string false false false false date-time
products Products object true true false false
extended Extended properties object false true false false
extraProperties Extra properties object false true false false

amount

Details of transaction

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

local

Currency local section

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
currency string false true 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

products

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

classifications

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

eventConfirmed

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventDeclined

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventEligible

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventInvited

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventNoShow

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventNotInvited

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

eventParticipated

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

host

host of the event

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

contacts

contacts of the host

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

eventRegistered

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

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

properties

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

eventLocation

The location of the event

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

address

The address details of the location

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

formCompiled

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

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

properties

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

genericActiveEvent

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

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

properties

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

genericPassiveEvent

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

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

properties

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

grantedCoupon

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

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

properties

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

deliveryChannel

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
id Id string false true false false
description Description string false true false false
name Name string false true false false

deliveryMedium

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
id Id string false true false false
description Description string false true false false
name Name string false true false false

loggedIn

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

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

properties

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

properties

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

openedTicket

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

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

properties

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

orderShipped

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

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

properties

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

removedCompare

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

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

properties

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

classifications

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

removedProduct

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

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

properties

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

classifications

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

removedReward

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

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

properties

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

removedWishlist

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

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

properties

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

classifications

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

repliedTicket

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

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

properties

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

reviewedProduct

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

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

properties

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

classifications

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

searched

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

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

properties

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

serviceSubscribed

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

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

properties

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

serviceUnsubscribed

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

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

properties

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

surveyCompiled

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

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

properties

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

viewedPage

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

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

properties

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

viewedProduct

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

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

properties

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

classifications

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

viewedProductCategory

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

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

properties

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

CONTEXTS

CONTACT_CENTER

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

client

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

localization

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

DIGITAL_CAMPAIGN

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

client

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

localization

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

ECOMMERCE

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

IOT

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

MOBILE

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

client

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

localization

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

device

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

OTHER

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

RETAIL

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
client Client object false true false false
salesAssistant Sales assistant object false true false false
store Store object false true false false
user User object false true false false

salesAssistant

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

contacts

The contact information for the sales assistant

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

SOCIAL

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

client

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

localization

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

WEB

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

MODELS

client

The client information refer to the event

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

localization

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

eventbringbackproperties

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

geographiclocation

The geographic coordinate of the location

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

indexed-consent

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
status Status boolean false true false true
limitation Limitation boolean false true false false
objection Objection boolean false true false false

not-indexed-consent

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
status Status boolean false true false false
limitation Limitation boolean false true false false
objection Objection boolean false true false false

store

The store information refer to the event

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

tracking

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

ga

Tracking with Google Analytics parameters

Name Label Type Array Nullable Required Indexed Kind Format Pattern Enum
utm_source Campaign Source string false false false false
utm_medium Campaign Medium string false false false false
utm_term Campaign Term string false false false false
utm_content Campaign Content string false false false false
utm_campaign Campaign Name string false false false false

user

The user information refer to the event

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

contacts

The contact information for the user

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