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.


Visited the website

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)

UTM parameters detected

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



Signed up

System name: $registered

Attribute Description
$name User name
$email User email



Authorized

System name: $authorized

Attribute Description
$name User name
$email User email



Tried to leave the website

System name: $leave_site_attempt



Email - defined or changed

System name: $email_changed



Name - defined or changed

System name: $name_changed



Phone - defined or changed

System name: $phone_changed



Chat is hidden from the visitor

System name: $user_banned



Visitor is merged

System name: $user_merged



Chat is shown to the visitor

System name: $user_unbanned



Chat is shown to the visitor

System name: $page_view



Logged out

System name: $logout



Input field filled

System name: $input_filled



Filled in the form

System name: $form_sended



Facebook lead form is filled

System name: $filled_facebook_lead_ad



Lead confirmed email

System name: $double_opt_in_confirmed



Confirmation email was sent

System name: $double_opt_in_send



Communication

Events, connected to manual and auto-messages.


User started a chat conversationе

System name: $conversation_user_started

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

Message sent

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)

Message read

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)

Answered the message

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)

Unsubscribed from the email-campaign

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)



Scheduled a meeting via Calendly

System name: $calendly_invitee_created



Interrupted the leadbot

System name: $chat_bot_interrupted



Got into the control group

System name: $message_control_group



Joined Zoom meeting

System name: $zoom_meeting_joined



Communication with the lead bot was finished

System name: $chat_bot_finished



The first message of the lead bot was sent

System name: $chat_bot_sent



The first message of the lead bot was read

System name: $chat_bot_read



Answered the first message of the lead bot

System name: $chat_bot_replied



Bounced – mail not delivered

System name: $message_bounced



Sent email to spam

System name: $message_spam



Goal reached

System name: $goal_completed



Subscribed to Web Push

System name: $push_subscribed



Unsubscribed from Web Push

System name: $push_unsubscribed



Question in the conversation is solved

System name: $conversation_part_group_closed



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.

Attribute 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.

Attribute Description
$order_id Order ID

Order delivered

System name: $order_closed

Event is tracked, when a customer receives the order.

Attribute Description
$order_id Order ID

Order cancelled

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

Payment refunded

System name: $order_refunded

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

Attribute Description
$order_id Order ID

Item added into cart

System name: $cart_added

Attribute 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.

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

Product viewed

System name: $product_viewed

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