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:
For any site type.
System name: $session_start
Attribute | 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 ) |
System name: $utm_hit
Attribute | Description |
---|---|
$utm_source |
UTM Source |
$utm_campaign |
UTM Campaign |
$utm_medium |
UTM Medium |
$utm_content |
UTM Content |
$utm_term |
UTM Term |
System name: $registered
Attribute | Description |
---|---|
$name |
User name |
$email |
User email |
System name: $authorized
Attribute | Description |
---|---|
$name |
User name |
$email |
User email |
System name: $leave_site_attempt
System name: $email_changed
System name: $name_changed
System name: $phone_changed
System name: $user_banned
System name: $user_merged
System name: $user_unbanned
System name: $page_view
System name: $logout
System name: $input_filled
System name: $form_sended
System name: $filled_facebook_lead_ad
System name: $double_opt_in_confirmed
System name: $double_opt_in_send
Events, connected to manual and auto-messages.
System name: $conversation_user_started
Attribute | Description |
---|---|
$body |
Message text (first 255 symbols) |
$conversation_id |
Conversation ID |
System name: $message_sended
Attribute | 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_read
Attribute | 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_replied
Attribute | 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
Attribute | 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_unsubscribed
Attribute | 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: $calendly_invitee_created
System name: $chat_bot_interrupted
System name: $message_control_group
System name: $zoom_meeting_joined
System name: $chat_bot_finished
System name: $chat_bot_sent
System name: $chat_bot_read
System name: $chat_bot_replied
System name: $message_bounced
System name: $message_spam
System name: $goal_completed
System name: $push_subscribed
System name: $push_unsubscribed
System name: $conversation_part_group_closed
E-commerce specific events.
System name: $order_started
This event is tracked when a user starts checkout process.
System name: $order_completed
User passed through all checkout steps and the order is registered in online-store system.
Attribute | Description |
---|---|
$order_id |
Order ID (inner) |
$order_id_human |
Order ID (human. Visible to customer) |
$order_amount |
Order amount |
System name: $order_paid
Event is tracked, when order is paid by customer.
Attribute | Description |
---|---|
$order_id |
Order ID |
System name: $order_closed
Event is tracked, when a customer receives the order.
Attribute | Description |
---|---|
$order_id |
Order ID |
System name: $order_cancelled
Event is tracked when the order is cancelled by the shop (or customer).
Attribute | Description |
---|---|
$order_id |
Order ID |
$comment |
Comment |
System name: $order_refunded
Event is tracked, when payment was refunded to the user.
Attribute | Description |
---|---|
$order_id |
Order ID |
System name: $cart_added
Attribute | Description |
---|---|
$name |
Product name |
$url |
Product description page url |
$amount |
Product price (integer) |
$img |
Product image link |
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
.
Attribute | 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 |
System name: $product_viewed
Attribute | Description |
---|---|
$name |
Product name |
$url |
Product description page url |
$amount |
Product price (integer) |
$img |
Product image link |