Platform X
Search…
⌃K

Events reference

add_payment_info

This event signifies a user has submitted their payment information
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
payment_method
string
Yes
card
The chosen method of payment (see list of possible values below)
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
coupon
string
No
CHRISTMAS
Coupon code used for a purchase.
revenue
number
No
16.00
Revenue (shipping price and taxes excluded) after discount. ()revenue is typically required for meaningful reporting.
()currency is required if you set revenue.
currency
string (ISO 4217)
No
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
items
No
The items for the event.
Example
cact('trigger','add_payment_info', {
payment_method: 'card',
revenue: 16.00,
value: 22.53,
currency: 'EUR'
});

add_shipping_info

This event signifies a user has submitted their shipping information.

Parameters

Name
Type
Required
Example value
Description
currency
string (ISO 4217)
Yes
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue or valueparameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
value
number
Yes
22.53
The monetary value of the event (shipping price and taxes included) after discount
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
coupon
string
No
CHRISTMAS
Coupon code used for a purchase.
shipping_tier
string
No
Ground
The shipping tier (e.g. Next-day, Air`) selected for delivery of the purchased item.
items
Yes
The items for the event.

add_to_cart

This event signifies that an item was added to a cart for purchase.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
value
number
Yes*
8.00
The monetary value of the event. ()value is typically required for meaningful reporting.
()currency is required if you set value.
currency
string (ISO 4217)
Yes*
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
items
Yes
The items for the event.
Example
cact('trigger','add_to_cart', {
value: 8.00,
currency: 'EUR',
items: [{
id: 'SKU_12345',
quantity: 1,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
price: 9.99
}
}]
});

add_to_wishlist

The event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
value
number
No
8.00
The monetary value of the event. ()revenue is typically required for meaningful reporting.
()currency is required if you set revenue.
currency
string (ISO 4217)
No
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
items
Yes
The items for the event.
Example
cact('trigger','add_to_wishlist', {
value: 8.00,
currency: 'EUR',
items: [{
id: 'SKU_12345',
quantity: 1,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
price: 9.99
}
}]
});

begin_checkout

This event signifies that a user has begun a checkout.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
revenue
number
Yes
16.00
The monetary value of the event (shipping price and taxes excluded) after discount
value
number
Yes
22.53
The monetary value of the event (shipping price and taxes included) after discount
currency
string (ISO 4217)
Yes
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
coupon
string
No
CHRISTMAS
Coupon code used for a purchase.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
items
Yes
The items for the event.
Example
cact('trigger','begin_checkout', {
id: 'O_12345',
coupon: 'CHRISTMAS',
revenue: 16.00,
value: 20.33,
currency: 'EUR',
user: {
id: '12356',
},
items: [{
id: 'SKU_12345',
quantity: 1,
price: 9.99,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
colors: ['red'],
price: 9.99
}
}, {
id: 'SKU_12346',
quantity: 1,
price: 9.99,
variant: 'green',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12346',
name: 'Heart tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'girl',
brand: 'Jenyfion',
colors: ['blue','white'],
price: 9.99
}
}]
})

generate_lead

Log this event when a lead has been generated to understand the efficacy of your re-engagement campaigns.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
value
number
No*
9.99
The monetary value of the event. ()revenue is typically required for meaningful reporting.
()currency is required if you set revenue.
currency
string (ISO 4217)
No*
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
id
string
No
Lead id
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
Example
cact('trigger','generate_lead', {
currency: 'EUR',
value: 9.99,
id: 'L_12345'
});

login

Send this event to signify that a user has logged in.

Parameters

Name
Type
Required
Example
Description
method
string
No
LinkedIn
The method used to login.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
Example
cact('trigger', 'login', {
method: 'LinkedIn'
});

page_view

The page_view call lets you record whenever a user sees a page of your website, along with any optional properties about the page.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
page_type
string
Yes
product_list
Page category. Recommanded predefined types:
  • home
  • landing
  • product_list
  • product
  • content_list
  • content
  • search
  • funnel
  • success
  • funnel_confirmation
  • account
  • cart
  • legal (e.g. Privacy Policy)
Equivalent to tc_vars.env_template
page_name
string
No
Suggestion for Mother's Day
Name of the page.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
Automatically added parameters by cact API for web sources
Name
Type
Required
Example Value
Description
title
string
No
Products - MySite.com
Title of the page :document.title from the DOM API
url
string
No
Full URL of the page. Equivalent tolocation.href from the DOM API.
path
string
No
/products/mothers
Path portion of the URL of the page : location.pathname from the DOM API.
referrer
string
No
Full URL of the previous page : document.referrer from the DOM API.
Example
cact('trigger','page_view', {
page_type: 'product_list',
page_name: 'Best sellers'
});

purchase

Fire this event when one or more items are purchased by a user.

Parameters (required and recommended)

Name
Type
Required
Example
Description
id
string
Yes
O_1245
Transaction id. Used as key for updates
user
Yes
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
All properties that you add here will be used as conditions for matching users in our database.
cosent_categories is automatically filled if you use Commanders Act CMP.
revenue
number
Yes
16.00
The monetary value of the event (shipping price and taxes excluded) after discount
value
number
Yes
22.53
The monetary value of the event (shipping price and taxes included) after discount
shipping_amount
number
No
3.33
Shipping cost associated with a transaction.
tax_amount
number
No
3.20
Tax associated with a transaction.
currency
string (ISO 4217)
Yes
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
coupon
string
No
CHRISTMAS
Coupon code used for a purchase.
type
string
Yes
offline
Type of conversion (online, offline, call etc.)
items
Yes
The items for the event.
payment_method
string
Yes
card
Payment method type (see list of possible values below)
status
string
Yes
in_progress
Status of the conversion (see list of possible values below). Conversions with status "pending" are not included in default sum and counts aggregated on augmented user attributes feature
Automatically added by cact API
Name
Type
Required
Example
Description
url
string(url)
No
none
URL to the website where you can buy the item
Equivalent to window.location.href
Example
cact('trigger','purchase', {
id: 'O_12345',
coupon: 'CHRISTMAS',
revenue: 16.00,
value: 20.33,
shipping_amount: 3.33,
tax_amount: 3.20,
currency: 'EUR',
user: {
id: '12356',
},
items: [{
id: 'SKU_12345',
quantity: 1,
price: 9.99,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
colors: ['red'],
price: 9.99
}
}, {
id: 'SKU_12346',
quantity: 1,
price: 9.99,
variant: 'green',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12346',
name: 'Heart tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'girl',
brand: 'Jenyfion',
colors: ['blue','white'],
price: 9.99
}
}]
})

refund

Fire this event when a purchase was refund

Parameters (required and recommended)

Name
Type
Required
Example
Description
id
string
Yes
O_1245
Transaction id. Used as key for updates
user
No
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
All properties that you add here will be used as conditions for matching users in our database.
cosent_categories is automatically filled if you use Commanders Act CMP.
revenue
number
Yes
16.00
The monetary value of the event (shipping price and taxes excluded) after discount
value
number
Yes
22.53
The monetary value of the event (shipping price and taxes included) after discount
shipping_amount
number
No
3.33
Shipping cost associated with a transaction.
tax_amount
number
No
3.20
Shipping cost associated with a transaction.
currency
string (ISO 4217)
Yes
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
coupon
string
No
CHRISTMAS
Coupon code used for a purchase.
type
string
Yes
offline
Type of conversion (online, offline, call etc.)
items
No*
(*) items is required for partial refunds but it can be omitted for full refunds.
Automatically added by cact API
Name
Type
Required
Example
Description
url
string(url)
No
none
URL to the website where you can buy the item
Equivalent to window.location.href
Example
cact('trigger','refund', {
id: 'O_12345',
coupon: 'CHRISTMAS',
revenue: 16.00,
value: 20.33,
shipping_amount: 3.33,
tax_amount: 3.20,
currency: 'EUR'
})

remove_from_cart

This event signifies that an item was removed from a cart.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
value
number
No
8.00
The monetary value of the event. ()value is typically required for meaningful reporting.
()currency is required if you set value.
currency
string (ISO 4217)
No
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
items
Yes
The items for the event.
Example
cact('trigger','remove_from_cart', {
value: 8.00,
currency: 'EUR',
items: [{
id: 'SKU_12345',
quantity: 1,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
price: 9.99
}
}]
});
Use this event to contextualize search operations. This event can help you identify the most popular content in your app.

Parameters

Name
Type
Required
Example value
Description
search_term
string
Yes
t-shirts
The term that was searched for.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).

Example

cact('trigger','search', {
search_term: 't-shirts'
});

select_content

This event signifies that a user has selected some content of a certain type. This event can help you identify popular content and categories of content in your app or click on internal promotion.

Parameters

Name
Type
Required
Example value
Description
content_type
string
No
product
The type of selected content.
item_id
string
No
I_12345
An identifier for the item that was selected.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).

Example

cact('trigger','select_content', {
content_type: 'product',
item_id: 'I_12345'
});

select_item

This event signifies an item was selected from a list.

Parameters

Name
Type
Required
Example value
Description
item_list_name
string
No
Related products
The name of the list in which the item was presented to the user.
items
Yes
The items for the event. The items array is expected to have a single element, representing the selected item.
Example
cact('trigger','select_item', {
item_list_name: 'Related products',
items: [{
id: 'SKU_12345',
quantity: 1,
variant: 'red',
coupon: 'CHRISTMAS',
discount: 1.99,
product:{
id: '12345',
name: 'Trex tshirt',
category_1: 'clothes',
category_2: 't-shirts',
category_3: 'boy',
brand: 'Lacoste',
price: 9.99
}
}]
});

sign_up

This event indicates that a user has signed up for an account.

Parameters (required and recommended)

Name
Type
Required
Example
Description
method
string
No
Facebook
The method used for sign up.
user
Yes*
{ id: '12345', email: '[email protected]',
consent_categories: [1,3]
}
consent_categories is the user's consents list. It is automatically filled from web sources if you use Commanders Act CMP.
You should also add all user's properties in this user object, especially reconciliation key (id, email).
Example
cact('trigger','sign_up', {
method: 'email'
});

view_cart

This event signifies that a user viewed their cart.
Parameters (required and recommended)
Name
Type
Required
Example Value
Description
value
number
No
8.00
The monetary value of the event. ()value is typically required for meaningful reporting.
()currency is required if you set value.
currency
string (ISO 4217)
No
EUR
Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
(*) If you supply the revenue parameter, you must also supply the currency parameter so revenue metrics can be computed accurately.
user