Events

An event is a user action that you consider important (for example, making an order, registering, paying a subscription, visiting a page with tariffs, visiting a product page, etc.)

You can send an event with our name into our system. Events beginning with the dollar symbol are system reserved names:

General:

Communication:

E-commerce:

General

For any site type.


Session start

System name: $session_start

Property Description
$referrer Referrer(source)
$referrer_domain Referrer(source), only domain
$browser Browser
$os Operating system
$device Device
$ip User’s ip-address
$resolution User’s device display resolution
$device_type Device type (pc, mobile, tablet)

UTM-tags detected

System name: $utm_hit

Property Description
$utm_source UTM Source
$utm_campaign UTM Campaign
$utm_medium UTM Medium
$utm_content UTM Content
$utm_term UTM Term



Registered

System name: $registered

Property Description
$name User name
$email User email



Authorized

System name: $authorized

Property Description
$name User name
$email User email



Communication

Events, connected to manual and auto-messages.


User started a chat conversationе

System name: $conversation_user_started

Property Description
$body Message text (first 255 symbols)
$conversation_id Conversation ID

Communication: Message sent

System name: $message_sended

Property Description
$message_id Message ID
$message_type Contains auto for auto-messages or manual for manual messages.
$message_name Message name (only auto-messages)
$type Contains message type (popup_chat, popup_big, popup_small, email)

Communication: Message read

System name: $message_read

Property Description
$message_id Message ID
$message_type Contains auto for auto-messages or manual for manual messages.
$message_name Message name (only auto-messages)
$type Contains message type (popup_chat, popup_big, popup_small, email)

Communication: Message replied

System name: $message_replied

Property Description
$message_id Message ID
$message_type Contains auto for auto-messages or manual for manual messages.
$message_name Message name (only auto-messages)
$type Contains message type (popup_chat, popup_big, popup_small, email)

System name: $message_clicked

Property Description
$message_id Message ID
$message_type Contains auto for auto-messages or manual for manual messages.
$message_name Message name (only auto-messages)
$type Contains message type (popup_chat, popup_big, popup_small, email)

Communication: Unsubscribed from emails

System name: $message_unsubscribed

Property Description
$message_id Message ID
$message_type Contains auto for auto-messages or manual for manual messages.
$message_name Message name (only auto-messages)
$type Contains message type (popup_chat, popup_big, popup_small, email)



E-commerce

E-commerce specific events.


Order started

System name: $order_started

This event is tracked when a user starts checkout process.


Order completed

System name: $order_completed

User passed through all checkout steps and the order is registered in online-store system.

Property Description
$order_id Order ID (inner)
$order_id_human Order ID (human. Visible to customer)
$order_amount Order amount

Order paid

System name: $order_paid

Event is tracked, when order is paid by customer.

Property Description
$order_id ID заказа

Order delivered

System name: $order_closed

Event is tracked, when a customer receives the order.

Property Description
$order_id ID заказа

Order cancelled

System name: $order_cancelled

Event is tracked when the order is cancelled by the shop (or customer).

Property Description
$order_id Order ID
$comment Comment

Payment refunded

System name: $order_refunded

Event is tracked, when payment was refunded to the user.

Property Description
$order_id Order ID

Item added into cart

System name: $cart_added

Property Description
$name Product name
$url Product description page url
$amount Product price (integer)
$img Product image link

Cart viewed

System name: $cart_viewed

All of this event’s properties are arrays.

For example, there are two goods with names A, B and prices 10, 20. Then the $name property will be A,B, and the $amount property value will be 10,20.

Property Description
$name Array with product names
$url Array of Product description page urls
$amount Array of Product prices (integer)
$img Array of Product image links

Product viewed

System name: $product_viewed

Property Description
$name Product name
$url Product description page url
$amount Product price (integer)
$img Product image link