1 min read

Events

Last Updated - Platform v21

The Contact is updated by default using the PoqUserID. This is usually not the best identifier so when integration you can easily configure this to match your website tracked CustomerIdentifier.

Account

Sent when the user registers a new account. This also updates the Contact.

signUp:
userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId)
marketingOptIn: newsletter_accept? # 1 (true) / 0 (false)
dataOptIn: privacy_accept? # 1 (true, data-dependent) / 0 (false)

Sent when the user logs in with an existing account. This also updates the Contact.

login:
userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId)

Sent when the user logs out. This also updates or clears the Contact.

logout:
userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId, this is the id of the guest user)

Sent when the user successfully edits their profile.

editDetails:
userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId, this is the id of the guest user)

Address Book

Sent when the user updates their address book.

addressBook:
action: action # Change / Add / Remove
userId: user_id # 123e4567-e89b-12d3-a456-426614174000 (usually PoqUserId)

Cart

Sent when the user views their Cart. This is a Predict event.

trackCart:
items:
- itemId: sku # PRD28104D-RED-M
price: price # 12.99
quantity: quantity # 1
- itemId: sku # PRD0492S-B
price: price # 2.49
quantity: quantity # 2

Checkout

Sent when the user successfully purchases the Cart. This is a Predict event.

trackPurchase:
orderId: order_id # ORD12948183402
items:
- itemId: sku # PRD28104D-RED-M
price: price # 12.99
quantity: quantity # 1
- itemId: sku # PRD0492S-B
price: price # 2.49
quantity: quantity # 2

Product Details

Sent when the user navigates to a Product Details screen. This is a Predict event.

trackItem:
itemId: listing_id / variant_id # PRD28104D-RED

Product List

Sent when the user navigates to the Product List, via a category, from the Shop screen or a category search suggestion. This is a Predict event.

trackCategory:
categoryPath: category_tree # dresses>petite>new-in

Sent when the user navigates to the Product List from a search result. This is a Predict event.

trackSearch:
searchTerm: search_query # summer

Other

Sent when the user changes country via the Country Switcher.

switchCountry:
countryCode: country_code # US / GB