События

Событие — это дейcтвие пользователя, которое вы считаете важным (например, совершил заказ, зарегистрировался, оплатил подписку, перешел на страницу с тарифами, посмотрел товар и т.д.).

Вы можете отправлять в нашу систему события с любым именем. События, начинающиеся с символа $, являются системными (с зарезервированными стандартными именами). Заголовок каждого события ниже — его название в интерфейсе Carrot quest, а системное имя — ключ, под которым событие доступно в API и SDK.

Атрибуты — это свойства события. Их имена указаны так, как они записываются в событие: часть из них без символа $ и с пробелами в имени.

Общее:

Коммуникации:

AI-агент:

Квиз:

Демо:

CRM:

Интернет-магазины:

Общее

Основные события, используемые для любого типа сайта.


Зашел на сайт

Системное имя: $session_start.

Пользователь зашел на сайт.

Атрибут Описание
$referrer Реферрер (источник)
$referrer_domain Реферрер (источник), только домен
$browser Браузер
$os Операционная система
$device Устройство
$ip IP пользователя
$resolution Разрешение экрана пользователя
$device_type Тип устройства (pc, mobile, tablet)

Пользователь открыл страницу

Системное имя: $page_visited.

Пользователь открыл страницу сайта.

Атрибут Описание
title Заголовок страницы (тег title)
H1 Содержимое тега h1
breadcrumbs Хлебные крошки страницы
URL Адрес страницы

Обнаружены UTM-метки

Системное имя: $utm_hit.

У пользователя обнаружены UTM-метки.

Атрибут Описание
$utm_source UTM Source
$utm_campaign UTM Campaign
$utm_medium UTM Medium
$utm_content UTM Content
$utm_term UTM Term

Зарегистрировался

Системное имя: $registered.

Пользователь создал новый аккаунт в личном кабинете.

Атрибут Описание
$name Имя пользователя
$email Email пользователя

Авторизовался

Системное имя: $authorized.

Пользователь авторизовался в личном кабинете.

Атрибут Описание
$name Имя пользователя
$email Email пользователя

Вопрос диалога разрешён

Системное имя: $conversation_part_group_closed.

Один вопрос внутри диалога помечен решенным.

Атрибут Описание
$conversation_id ID диалога

Пользователь подтвердил email

Системное имя: $double_opt_in_confirmed.

Пользователь перешёл по ссылке в письме, чтобы подтвердить свой email.

Атрибут Описание
$email Email пользователя

Письмо для подтверждения email отправлено

Системное имя: $double_opt_in_send.

Пользователю отправлено double opt-in письмо для подтверждения email.

Атрибут Описание
$email Email пользователя

Email – записан или изменен

Системное имя: $email_changed.

Email пользователя записан или изменен.

Атрибут Описание
old_value Прежнее значение
new_value Новое значение

Имя – записано или изменено

Системное имя: $name_changed.

Имя пользователя записано или изменено.

Атрибут Описание
old_value Прежнее значение
new_value Новое значение

Телефон – записан или изменен

Системное имя: $phone_changed.

Телефон пользователя записан или изменен.

Атрибут Описание
old_value Прежнее значение
new_value Новое значение

Статус пользователя изменился

Системное имя: $user_status_changed.

Статус пользователя пересчитан и изменился: visitor → engaged → lead → user → customer. Пишется только когда значение действительно стало другим; в атрибутах — прежнее и новое значение и то, что вызвало пересчёт.

Атрибут Описание
old_value Прежнее значение
new_value Новое значение
trigger_event Событие, которое вызвало пересчёт статуса

Попытался уйти с сайта

Системное имя: $leave_site_attempt.

Пользователь навёл курсор на границу с браузером.

Атрибут Описание
URL Адрес страницы

Вышел из учетной записи

Системное имя: $logout.

Пользователь вышел из личного кабинета.


Чат скрыт у пользователя

Системное имя: $user_banned.

Пользователь заблокирован в сервисе. После блокировки пользователь не может написать в чат.


Чат снова показывается пользователю

Системное имя: $user_unbanned.

Пользователь разблокирован в сервисе (он может писать в чат).


Пользователь склеен

Системное имя: $user_merged.

Два пользователя объединены в одного — автоматически через интеграции/импорт, либо вручную.


Заполнил форму сбора лидов Facebook

Системное имя: $filled_facebook_lead_ad.

Пользователь заполнил форму сбора лидов Facebook.


Заполнил форму

Системное имя: $form_sended.

Пользователь заполнил любую форму на сайте.


Заполнил поле ввода

Системное имя: $input_filled.

Пользователь заполнил поле ввода в форме на сайте.


Подписался на Web Push

Системное имя: $push_subscribed.

Пользователь подписался на Web Push-уведомления.


Отписался от Web Push

Системное имя: $push_unsubscribed.

Пользователь отписался от Web Push-уведомлений.


Цель достигнута

Системное имя: $goal_completed.

Пользователь достиг заданной цели.


Предоставил согласие на обработку персональных данных

Системное имя: $allowed_data_processing_policy.

Пользователь дал согласие на обработку своих данных в соответствии с политикой обработки данных.


Предоставил согласие на использование телефона

Системное имя: $allowed_phone_collection.

Пользователь дал согласие на обработку номера телефона в соответствии с политикой обработки данных.


Предоставил согласие на использование email

Системное имя: $allowed_email_collection.

Пользователь дал согласие на обработку e-mail в соответствии с политикой обработки данных.

Атрибут Описание
$email Email пользователя

Системное имя: $allowed_cookie_processing_policy.

Пользователь согласился на использование cookie-файлов.



Коммуникации

События, связанные с авто- и ручными сообщениями.


Начат чат

Системное имя: $conversation_user_started.

Пользователь начал диалог в чате.

Атрибут Описание
$body Текст сообщения (первые 255 символов)
$conversation_id ID диалога

Открыл стартовый экран виджета чата

Системное имя: $start_screen_opened.

Пользователь открыл стартовый экран виджета чата.

Атрибут Описание
URL Адрес страницы

Открыл экран диалога

Системное имя: $conversation_screen_opened.

Пользователь открыл экран диалога чата.

Атрибут Описание
URL Адрес страницы

Отправлено сообщение

Системное имя: $message_sended.

Пользователю отправлено сообщение.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)
$type Содержит тип сообщения (popup_chat, popup_big, popup_small, email)

Прочитано сообщение

Системное имя: $message_read.

Пользователь прочитал сообщение.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)
$type Содержит тип сообщения (popup_chat, popup_big, popup_small, email)

Ответил на сообщение

Системное имя: $message_replied.

Пользователь ответил на сообщение.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)
$type Содержит тип сообщения (popup_chat, popup_big, popup_small, email)

Перешел по ссылке в сообщении

Системное имя: $message_clicked.

Пользователь перешел по ссылке в сообщении.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)
$type Содержит тип сообщения (popup_chat, popup_big, popup_small, email)

Отписался от рассылки писем

Системное имя: $message_unsubscribed.

Пользователь отписался от рассылки писем.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)
$type Содержит тип сообщения (popup_chat, popup_big, popup_small, email)

Попал в контрольную группу

Системное имя: $message_control_group.

Пользователь попал в контрольную группу триггерного сообщения для сравнения с целевой группой.


Отправил письмо в spam

Системное имя: $message_spam.

Пользователь отправил письмо в spam.

Атрибут Описание
$message_id ID сообщения
$message_type Содержит auto для автосообщений и manual для ручных сообщений
$message_name Имя сообщения (только для автосообщений)

Bounced – сообщение не доставлено

Системное имя: $message_bounced.

Bounced – письмо не доставлено пользователю.

Атрибут Описание
$email Email пользователя

Адрес email отправлен в карантин

Системное имя: $email_quarantined.

Email пользователя временно исключён из отправки — письма на него не уходят, пока карантин не снят.

Атрибут Описание
$email Email пользователя

Карантин адреса email снят

Системное имя: $email_quarantine_released.

Email пользователя снова доступен для отправки писем.

Атрибут Описание
$email Email пользователя

Адрес email признан невалидным после повторных ошибок доставки

Системное имя: $email_invalidated_by_soft_bounce.

Письма на email пользователя повторно не доходили, адрес помечен невалидным — отправка на него прекращается.

Атрибут Описание
$email Email пользователя

Отправлено первое сообщение лид-бота

Системное имя: $chat_bot_sent.

Пользователю отправлено первое сообщение лид-бота.

Атрибут Описание
$bot_name Название лид-бота
$bot_id ID лид-бота

Прочитал первое сообщение лид-бота

Системное имя: $chat_bot_read.

Пользователь прочитал первое сообщение лид-бота.

Атрибут Описание
$bot_name Название лид-бота
$bot_id ID лид-бота

Ответил на первое сообщение лид-бота

Системное имя: $chat_bot_replied.

Пользователь ответил на первое сообщение лид-бота.

Атрибут Описание
$bot_name Название лид-бота
$bot_id ID лид-бота

Прервал диалог с лид-ботом

Системное имя: $chat_bot_interrupted.

Пользователь прервал диалог с лид-ботом.

Атрибут Описание
$bot_name Название лид-бота
$bot_id ID лид-бота

Закончил общение с лид-ботом

Системное имя: $chat_bot_finished.

Пользователь закончил диалог с лид-ботом.

Атрибут Описание
$bot_name Название лид-бота
$bot_id ID лид-бота

Поделился контактом в Telegram-боте

Системное имя: $telegram_shared_contact.

Пользователь поделился контактом в Telegram-боте: нажал на кнопку в Telegram, которая запрашивает контактные данные.

Атрибут Описание
Contact Контактные данные, которыми поделился пользователь

Поделился контактом в Max-боте

Системное имя: $max_shared_contact.

Пользователь отправил контактные данные из мессенджера Max.

Атрибут Описание
Contact Контактные данные, которыми поделился пользователь

Присоединился к встрече Zoom

Системное имя: $zoom_meeting_joined.

Пользователь присоединился к встрече в Zoom.


Клик по иконке Facebook в хедере чата

Системное имя: $clicked_chat_header_icon_facebook.

Пользователь нажал на значок Facebook в шапке виджета чата, чтобы перейти в Facebook messenger как канал коммуникации.

Атрибут Описание
URL Адрес страницы

Клик по иконке Telegram в хедере чата

Системное имя: $clicked_chat_header_icon_telegram.

Пользователь нажал на значок Telegram в шапке виджета чата, чтобы перейти в Telegram в качестве канала связи.

Атрибут Описание
URL Адрес страницы

Клик по иконке WhatsApp в хедере чата

Системное имя: $clicked_chat_header_icon_whatsapp.

Пользователь нажал на значок WhatsApp в шапке виджета чата, чтобы перейти в WhatsApp как канал коммуникации.

Атрибут Описание
URL Адрес страницы

Клик по иконке Instagram в хедере чата

Системное имя: $clicked_chat_header_icon_instagram.

Пользователь нажал на значок Instagram в шапке виджета чата, чтобы перейти в Instagram в качестве канала связи.

Атрибут Описание
URL Адрес страницы

Клик по иконке ВК в хедере чата

Системное имя: $clicked_chat_header_icon_vk.

Пользователь нажал на значок ВК в шапке виджета чата, чтобы перейти во ВКонтакте в качестве канала связи.

Атрибут Описание
URL Адрес страницы

Клик по иконке Viber в хедере чата

Системное имя: $clicked_chat_header_icon_viber.

Пользователь нажал на значок Viber в шапке виджета чата, чтобы перейти в Viber в качестве канала связи.

Атрибут Описание
URL Адрес страницы

Клик по иконке Max в хедере чата

Системное имя: $clicked_chat_header_icon_max.

Пользователь нажал на значок Max в шапке виджета чата, чтобы перейти в Max в качестве канала связи.

Атрибут Описание
URL Адрес страницы



AI-агент

События AI-агента: диалоги, квалификация лидов и передача менеджеру.


AI: квалификация начата

Системное имя: $ai_qualification_started.

AI-SDR агент начал задавать вопросы для квалификации пользователя.

Атрибут Описание
$conversation_id ID диалога
Conversation link Ссылка на диалог

AI: квалификация завершена

Системное имя: $ai_qualification_finished.

AI-SDR агент завершил задавать вопросы для квалификации пользователя.

Атрибут Описание
$conversation_id ID диалога
Conversation link Ссылка на диалог

AI: создан анализ диалога

Системное имя: $ai_conversation_analysis_created.

Создан AI-анализ диалога.

Атрибут Описание
$conversation_id ID диалога

AI: создано саммари диалога

Системное имя: $ai_conversation_summary_created.

Создано AI-саммари диалога.

Атрибут Описание
$conversation_id ID диалога

AI: создано саммари пользователя

Системное имя: $ai_user_summary_created.

Создано AI-саммари пользователя.


Определён тир лида

Системное имя: $lead_tier_detected.

Пользователю присвоен или обновлён тир (уровень) лида.

Атрибут Описание
$lead_tier Тир лида

Диалог передан менеджеру

Системное имя: $escalate_to_manager.

AI-агент передал диалог менеджеру и вышел из него.

Атрибут Описание
$conversation_id ID диалога
Conversation link Ссылка на диалог
Manager's name Имя менеджера

Менеджер приглашен в диалог

Системное имя: $mention_manager.

AI-агент пригласил менеджера присоединиться к диалогу.

Атрибут Описание
$conversation_id ID диалога
Conversation link Ссылка на диалог
Manager's name Имя менеджера



Квиз

События прохождения квиза.


Квиз: посещён

Системное имя: $quiz_visited.

Пользователь открыл страницу квиза.


Квиз: начат

Системное имя: $quiz_started.

Пользователь начал отвечать на вопросы квиза.


Квиз: завершён

Системное имя: $quiz_finished.

Пользователь закончил отвечать на вопросы квиза.



Демо

События запроса демонстрации продукта.


Демо: форма открыта

Системное имя: $demo_form_read.

Пользователь открыл форму заявки на сайте.

Атрибут Описание
URL Адрес страницы

Демо: форма заполнена

Системное имя: $demo_form_completed.

Пользователь оставил заявку в форме на сайте.

Атрибут Описание
$name Имя пользователя
$phone Телефон пользователя
$email Email пользователя
$demo_request_page Страница, с которой отправлена заявка
$accepted_terms Согласие с условиями использования
$accepted_privacy_policy Согласие с политикой конфиденциальности
$is_subscribed_to_newsletter Согласие на подписку на рассылку



CRM

События квалификации лидов, встреч и воронки продаж в CRM.


Является MQL

Системное имя: $mql.

Лид квалифицирован как качественный.

Атрибут Описание
Dialogue link Ссылка на диалог, в котором лид прошёл квалификацию

Не является MQL

Системное имя: $not_mql.

Лид квалифицирован как некачественный.

Атрибут Описание
Dialogue link Ссылка на диалог, в котором лид прошёл квалификацию

Лид квалифицирован

Системное имя: $lead_qualified.

Квалификация лида завершена.

Атрибут Описание
Is MQL / Is not MQL Результат квалификации: MQL или не MQL

Встреча запланирована

Системное имя: $meeting_scheduled.

Пользователь забронировал встречу с отделом продаж.

Атрибут Описание
Source Источник бронирования встречи
Meeting service Сервис, в котором назначена встреча
$meeting_link Ссылка на онлайн-встречу
$booking_manager_name Имя менеджера, на которого назначена встреча
$booking_slot_datetime Дата и время встречи

Встреча перенесена

Системное имя: $meeting_rescheduled.

Пользователь перенес встречу с отделом продаж.

Атрибут Описание
Source Источник бронирования встречи
Meeting service Сервис, в котором назначена встреча
$meeting_link Ссылка на онлайн-встречу
$booking_manager_name Имя менеджера, на которого назначена встреча
$booking_slot_datetime Дата и время встречи

Встреча отменена

Системное имя: $meeting_cancelled.

Пользователь отменил встречу с отделом продаж.

Атрибут Описание
Source Источник бронирования встречи
Meeting service Сервис, в котором назначена встреча
$meeting_link Ссылка на онлайн-встречу
$booking_manager_name Имя менеджера, на которого назначена встреча
$booking_slot_datetime Дата и время встречи

Calendly: Встреча запланирована

Системное имя: $calendly_invitee_created.

Пользователь забронировал встречу через виджет Calendly.


Calendly: встреча перенесена

Системное имя: $calendly_invitee_rescheduled.

Пользователь перенес встречу, назначенную через виджет Calendly.


Calendly: встреча отменена

Системное имя: $calendly_invitee_canceled.

Пользователь отменил встречу, назначенную через виджет Calendly.


CRM: контакт установлен

Системное имя: $crm_contact_established.

Данные из CRM: связь с лидом установлена.

Атрибут Описание
Contact channel Канал, через который установлена связь

CRM: квалифицирован

Системное имя: $crm_qualified.

Данные из CRM: лид квалифицирован.

Атрибут Описание
Is MQL / Is not MQL Результат квалификации: MQL или не MQL

CRM: встреча запланирована

Системное имя: $crm_meeting_scheduled.

Данные из CRM: встреча с лидом назначена.

Атрибут Описание
$booking_manager_name Имя менеджера, на которого назначена встреча
$booking_slot_datetime Дата и время встречи

CRM: встреча проведена

Системное имя: $crm_meeting_completed.

Данные из CRM: встреча с лидом состоялась.

Атрибут Описание
$booking_manager_name Имя менеджера, на которого назначена встреча
$booking_slot_datetime Дата и время встречи

CRM: встреча проведена

Системное имя: $crm_meeting.

Данные из CRM: встреча с лидом завершена.


CRM: возможность

Системное имя: $crm_opportunity.

Данные из CRM: есть возможность продажи.


CRM: счёт отправлен

Системное имя: $crm_invoice_sent.

Данные из CRM: счет отправлен лиду.

Атрибут Описание
$budget Бюджет сделки

CRM: оплачено

Системное имя: $crm_paid.

Данные из CRM: сделка оплачена.

Атрибут Описание
$budget Бюджет сделки

CRM: потеряно

Системное имя: $crm_lost.

Данные из CRM: сделка проиграна.

Атрибут Описание
Reason Причина, по которой сделка проиграна

CRM: лид доставлен

Системное имя: $crm_lead_delivered.

Данные из CRM: лид доставлен в CRM.

Атрибут Описание
CRM stage Этап сделки в CRM



Интернет-магазины

События, специфичные для сферы электронной коммерции.


Начато оформление заказа

Системное имя: $order_started.

Пользователь перешёл на первый шаг процесса чекаута.


Заказ создан

Системное имя: $order_completed.

Пользователь прошёл все шаги процесса чекаута, заказ создан в системе магазина.

Атрибут Описание
$order_id ID заказа (внутренний)
$order_id_human ID заказа человеческий (тот, который видит клиент)
$order_amount Сумма заказа

Заказ оплачен

Системное имя: $order_paid.

Пользователь оплатил заказ.

Атрибут Описание
$order_id ID заказа

Заказ получен

Системное имя: $order_closed.

Пользователь получил заказ.

Атрибут Описание
$order_id ID заказа

Заказ отменен

Системное имя: $order_cancelled.

Пользователь или магазин отменили заказ.

Атрибут Описание
$order_id ID заказа
$comment Комментарий

Оформлен возврат заказа

Системное имя: $order_refunded.

Пользователь получил возврат оплаты заказа.

Атрибут Описание
$order_id ID заказа

Добавил продукт в корзину

Системное имя: $cart_added.

Пользователь добавил продукт в корзину.

Атрибут Описание
$name Название товара
$url Ссылка на страницу с описанием товара
$amount Цена товара в рублях. Целое число (если есть копейки, их необходимо округлить)
$img Ссылка на картинку с товаром

Посмотрел корзину

Системное имя: $cart_viewed.

Пользователь открыл корзину.

Все свойства в этом событии являются массивами.

Например, есть два товара с названиями А,B и ценами 10,20. Тогда в свойстве $name будет лежать A,B, а в свойстве $amount значения 10,20.

Атрибут Описание
$name Массив с названиями товаров
$url Массив ссылок на страницы с описанием товара
$amount Массив с ценами товара в рублях. Целое число (если есть копейки, их необходимо округлить)
$img Массив со ссылками на картинку с товаром

Посмотрел продукт

Системное имя: $product_viewed.

Пользователь открыл страницу продукта.

Атрибут Описание
$name Название товара
$url Ссылка на страницу с описанием товара
$amount Цена товара в рублях. Целое число (если есть копейки, их необходимо округлить)
$img Ссылка на картинку с товаром