Документация MACRO
  • 🎓Руководство пользователя
    • MacroCRM
      • Заявки
        • Архитектура процесса продаж
        • Звонки 2.0
        • Логика создания заявок по звонкам
        • Добавление задачи
        • Добавление отчета по встрече
        • Как добавить агентство недвижимости и агентов, работающих в нем?
        • Как отправить клиенту несколько вариантов объектов?
        • Как узнать какие квартиры бронировал клиент?
        • Лента событий
        • Массовая смена менеджера в заявках
        • Может ли другой менеджер забрать у меня заявку без моего ведома?
        • Объединение заявок родственников
        • Отключение создания заявок для определенных ролей контактов
        • Очередь бронирования
        • Слияние контактов и заявок
        • Создание заявки
        • Создание контакта
        • Управление причинами перевода заявок в нерабочие статусы
        • Управление рекламными каналами привлечения заявок
        • Я ухожу в отпуск, что будет с моими заявками?
      • Недвижимость
        • Создание дома. Загрузка шахматки и массовое добавление объектов
        • Шахматка дома
        • Выравнивание объектов в шахматке по стоякам
        • Добавление поэтажных планировок
        • Добавление планировок объектов
        • Добавление тегов в объектах
        • Стартовое ценообразование
        • Как поставить бронь
        • Автоматическое формирование доплат/возвратов по результатам обмеров БТИ
        • Дополнительные площади в шахматке дома
        • Как быстро поставить маркетинговый резерв/сделку
        • Как добавить новые объекты в уже созданный дом
        • Как массово поставить маркетинговый резерв/сделку
        • Как перенести объекты из одного дома в другой
        • Копирование файлов объекта по стоякам
        • Массовая смена продавца объектов в доме
        • Массовое клонирование свойств объектов в доме
        • Массовое продление броней через эксель-шахматку
        • Массовое удаление объектов в доме
        • Объединение объектов
        • Ограничение сроков бронирования объектов
        • Отдельные акты приема-передачи объекта для разных категорий недвижимости
        • Перепродажа объектов
        • Признак эксклюзива для новостроек
        • Разделение шаблонов договоров для сделок с недвижимостью по ЖК/Домам
        • Служебные отметки в объектах
        • Создание группы домов
        • Поддерживающее ценообразование
        • Создание нового объекта недвижимости (вторичка)
      • Сделки
        • Связь ипотечных заявок с заявками на покупку недвижимости и сделками
        • Автоматическое формирование графика платежей по сделке
        • Автоматическое разнесение платежей, поступающих на Эскроу-счета
        • Автоматическая нумерация договоров
        • Автоматические задачи по сделке
        • Атрибуты в карточках контакта и сделки. Портрет покупателя
        • Добавление платежей в график при подписанном договоре
        • Добавление подстатусов в заявках
        • Дополнительные соглашения по сделкам
        • Как добавить ипотечный банк
        • Как перевести бронь в сделку
        • Распознавание документов 2.0
        • Расширенный сценарий работы с платным бронированием
        • Корректировки стоимости по договору
        • Куда загружать документы по сделке/по клиенту
        • Представители покупателей в сделке
        • Предустановленный номер договора
        • Интеграции с сервисами электронной регистрации
        • Работа с платежами по сделкам
        • Работа с уступками
        • Работа с залогами
        • Разделение согласователей и сотрудников договорного отдела по разным объектам
        • Расторжение сделок
        • Роли покупателей в сделке
        • Согласователи и их заместители
        • Создание и редактирование сделок через эксель-шахматку дома
        • Создание персональных дел
        • Срок фиксации цены по договору
        • Учет вклада нескольких менеджеров в сделку
        • Финансовый учет в сделках
        • Формирование возвратов по сделкам
      • Формирование документов
        • Динамическая фильтрация шаблонов документов в сделке
        • Отправка смс-сообщений. Шаблоны.
        • Создание массовых договоров долевого участия в одном шаблоне
        • Формирование пакета документов по набору объектов
        • Шаблоны документов. Создание и работа с шаблонами.
      • Отчеты
        • Воронка продаж
        • Динамика реализации недвижимости
        • Контроль сделок
        • Маркетинговые показатели
        • Нерабочие заявки
        • Отчет для минстроя по заключенным ДДУ
        • Отчет о встречах
        • Отчет о поступлениях за период
        • Отчет о скорости обработки заявок
        • Отчет о скорости проведения сделок
        • Отчёт о сроках ответа на пропущенный звонок
        • Отчет по броням
        • Отчет по заключённым договорам
        • Отчет по звонкам
        • Отчет по источникам заявок
        • Отчет по клиентам, купившим недвижимость
        • Отчет по просроченным платежам
        • Отчет по работе менеджеров с заявками
        • Первичный, вторичный интерес к ЖК
        • План продаж
        • План продаж (новый)
        • Портрет покупателя
        • Объекты, доступные для продажи агентам
      • Настройки
        • Максимальные сроки бронирования и продление броней
        • Презентации объектов
        • График работы сотрудников и его учет при постановке задач
        • Увольнение сотрудников
      • Передача ключей
      • Ипотека
      • Акции
        • Метка для вывода Акций в кастомные презентации
        • Вывод в шахматку разных вариантов цен на объекты недвижимости
    • MacroERP
      • Начало работы в MacroERP
        • Где находится MacroERP
        • Как зарегистрироваться в MacroERP
        • Как вывести значок системы на рабочий стол компьютера
        • Настройка профиля
        • Как сменить электронную почту
        • Как сменить пароль
        • Забыл пароль. Как восстановить?
        • Забыл выйти из учетной записи. Что делать?
        • Как подключить Telegram-бот
        • Как вывести значок системы на экран смартфона
        • Как работать с телефона?
        • Где узнавать об обновлениях системы?
        • Как создать Telegram-бот
      • Проекты
        • Модуль Проекты
        • Структура проектов.(Редактор. Создание проекта)
        • График производства работ. Общий вид.
        • Способы наполнения перечня работ ГПР
          • Создание ГПР "с нуля". Работа в редакторе графика
            • Формирование чек-листов в ГПР
            • Формирование перечня исполнительной документации
            • Алгоритм расчета связей ГПР
            • Редактор связей ГПР
            • Внесение веса работ
          • Клонирование проекта
          • Выгрузка проекта из MS Project
          • Выгрузка проекта из Excel
          • Создание ГПР на основании сметы
          • Создание ГПР из предмета договора
        • Редактор графика
        • Версии ГПР
        • Перенос сроков
        • Создание объекта
        • План работ
        • Экономика
        • План снабжения
        • Календарь расходов
        • План поставок
        • Чек-лист (В работе)
        • Удаление проекта
        • Завершение проекта/Возобновление проекта
        • Настройка параметров проекта
        • Процент выполнения работ по актам (КС)
        • Согласователи переноса сроков работ
        • Запуск графика в работу и возврат на доработку
        • Параметры проекта
        • Цветовая индикация сроков выполнения работ
        • Цветовая индикация групп работ
        • Запрос переноса срока начала/окончания работы
        • Добавить исполнительную документацию
        • Прикрепление файлов и ссылок в ГПР
        • Заказать ТМЦ из ГПР
        • Вызвать стройнадзор
        • Примечание к номенклатуре в плане снабжения
        • Создание задач и отслеживание их выполнения через ГПР
      • Снабжение
        • Настройка сценариев согласования заказа
        • Создание заказа в модуле "Снабжение"
        • Загрузка заказа ТМЦ из шаблона
        • Редактирование заказа
        • Работа с заказом
        • Разделение заказа
        • Как прикрепить документ к заказу
        • Фиксация поставщика и договора поставки в карточке заказа
        • Приемка ТМЦ
        • Передача ТМЦ подрядчику из карточки заказа
        • Возврат остатков от подрядчика
        • Формирование и скачивание товарной накладной (продажа)
        • Перемещение приемки ТМЦ между заказами
        • Логирование изменений Плана снабжения
        • Отчет о покупке ТМЦ
        • Сводная таблица
        • Создание склада
        • Журнал УПД
        • Списание ТМЦ на КС
        • Статусы заказа
        • Функция ограничение недопоставок
        • Сценарии работы модуля Снабжения
        • Справка по снабжению
        • Работа с заказами ТМЦ для роли «Прораб»
        • Работа с заказами ТМЦ для роли «Снабженец»
        • Работа с заказами ТМЦ для роли «Материалист»
      • Финансы
        • Модуль Финансы
        • Ограничение создания фин. операций для незакрытых работ ГПР
        • Признаки типов финансовых затрат
        • Прикрепление фин.операций к актам
        • Разнесение ФО по Статьям ДДС
        • Распределение финансовых операций
        • Создание расчетного счета
        • Статьи ДДС
        • Соотношение статей ДДС с ГПР
        • Автоматическое разнесение финансовой операции по статьям движения денежных средств
        • Реестр платежей
      • Документы
        • Модуль Документы
        • Фильтры в листинге документов
        • Листинг Документов
        • Настройки типов документов
        • Дополнительные статусы документов
        • Требования к договору
        • Обязательные документы для заключения договора
        • Создание договора в модуле Документы
        • Создание контрагента из карточки договора
        • Опции для автоматического подсчета количества, стоимости за единицу и суммы в предмете договора
        • График платежей
        • Разнесение оплат и авансов в графике платежей
        • Учет авансовых платежей
        • Гарантийные удержания
        • Опция "Начислять ГУ в % только с работ"
        • Добавление документов в договор
        • Загрузка предмета договора из шаблона
        • Заполнение предмета договора вручную
        • Заполнение предмета договора из сметы
        • Заполнение шаблона для загрузки в предмет договора
        • Изменение предмета договора без сброса согласования
        • Автоматическая расстановка цен у повторяющихся позиций
        • Схемы учета материалов в предмете договора
        • Изменение списка согласователей в договоре
        • Акт выполненных работ (АВР/КС-2) в документе
        • КС-3
        • Лист согласования актов выполненных работ
        • Настройка согласователей актов выполненных работ
        • Настройка шаблона листа согласования акта выполненных работ
        • Операторы актов выполненных работ (КС-2)
        • Параметры договора, Вложения, Итоговые документы.
        • Прочие удержания
        • Реестр КС (актов выполненных работ)
        • Отчет по списанию материалов на акт
        • Согласование/отмена согласования договора
        • Создание дополнительного соглашения
        • Типы дополнительных соглашений
        • ЭЦП и передача через Диадок
        • Доходные договора
        • План выполнения работ
        • Реестр планов выполнения работ
        • Шаблон документа
        • Ведомость о расходе основных материалов в строительстве (М-29)
      • Словарь строительных терминов
        • Глоссарий
      • Контакты
        • Модуль контакты
        • Добавление новых контактов
        • Карточка контакта
        • Как слить контакты (убрать дубли)
        • Роли контакта в системе
        • Ограничение доступа к контактам физ.лиц
      • Сметы
        • Заполнение шаблона сметы для ручного заполнения в Excel
        • Копирование смет
        • Создание сметы (Загрузка из ГрандСметы и WinРик)
        • Создание сметы вручную
        • Работа с шаблоном сметы MACRO
        • Привязка Сметы к ГПР
      • Стройконтроль
        • Функции стройконтроля
        • Приёмка работ
        • Подтверждение качества работ
        • Предписания и дефектовки
        • Вызов стройконтроля
        • Отображение предписаний и дефектовок в ГПР
        • Отчеты "Предписания" и "Дефектовки"
      • Часто задаваемые вопросы
        • Как добавить заказчика в договор?
        • Как добавить фактического отправителя в договор?
        • Как просмотреть дочерние заказы
        • Какие акты выполненных работ (КС) мне нужно согласовать?
        • Какие договоры мне нужно согласовать?
        • Какие фин.операции мне нужно акцептовать?
        • Какие фин.операции мне нужно согласовать?
        • Как посмотреть финансовые операции разнесенные по набору статей?
        • Как посмотреть финансовые операции не разнесенные по наборам статей затрат?
      • Административные настройки
        • Как восстановить уволенного сотрудника
        • Как уволить сотрудника
        • Настройки компании
          • Финансы
          • Строительство
          • Документы
          • Снабжение
          • Компания
        • Создание и редактирование тега
        • Формирование отделов
        • Настройка отделов
        • Функция "Отпуск"
        • Настройка Бота Telegram
      • Отчеты ERP
        • Оборотная ведомость по оплатам и выполненным работам
        • Отчет по статьям ДДС
        • Отчет по закрытым объемам работ
      • Подготовка к внедрению
        • Описание модулей ERP
        • Ориентировочный список сотрудников для регистрации в системе
        • Список запрашиваемых документов
    • MacroBank
      • Начало работы
        • Интерфейс системы
        • Справочники
        • Проекты
        • Контрагенты
      • Основные возможности
        • Раздел "Договоры"
        • Сметы
        • Раздел "Закрывающие документы"
        • Раздел "Финансовые операции"
      • Отчеты
        • Банковский учет
        • Управленческая отчетность
        • Бюджетирование
      • Интеграции
        • Фабрика
        • Подгрузка выписок из клиент-банков
    • MacroPlan
      • Задачи и поручения
      • Создание задачи
      • Работа с задачей
      • Работа с задачами. Листинг. Фильтры
      • Категории задач
      • Задача с типом Группа задач (Проект)
      • Постановка задач в Telegram-боте
      • Действия с задачами в Telegram-бот
      • Повторяемые задачи
      • Интеграция с календарем Google
      • Интеграция с Outlook
    • MacroCatalog
      • Установка на сайт
        • Сайт застройщика
        • Лэндинг на Tilda
        • Кнопка запуска
      • Контент каталога
        • Общие параметры каталога
        • Номер телефона отдела продаж
        • Уровень открытия каталога
        • Главное изображение дома
        • Разметка фасадов
        • Поэтажные планировки
        • Галерея изображений объекта
        • Виртуальный тур объекта
        • Теги в каталоге
        • Стороны света в каталоге
        • Описание дома и объектов в Macrocatalog
        • Срок сдачи дома в эксплуатацию
        • Фильтр по отделке
        • Онлайн-камера
        • Бейджи акций
        • Онлайн-калькулятор ипотеки
        • Подмена статусов объектов, скрытие стоимостей
      • Список событий, используемых для аналитики
    • Кабинет агента
      • Установка на сайт
      • Настройка работы KA
      • Распределение агентских заявок по ответственным менеджерам
      • Система поиска дублей заявок
      • Документация для показа в КА
      • Объявления и информация о комиссиях для всех агентов
      • Сервис подтверждения участия агента в сделке
      • Комиссионное вознаграждение посредников
      • Постановка броней из кабинета агента
      • Отчёт по объектам, доступным агентам
      • Статистика агентств недвижимости
    • Кабинет клиента
      • Установка на сайт
        • Установка кабинета клиента без MacroCatalog
        • Установка совместно с каталогом
      • Объявления и новости
    • MacroPrice
      • Робот-анализатор
        • Настройка условий
        • Логика расчета выбытий
      • Планировщик цен
        • Изменение цены по спецпредложению
    • MacroTender
      • Тендерная площадка
        • 1. Регистрация на площадке
        • 2. Подача заявки на аккредитацию
        • 3. Подачи заявки на участие в тендере
      • Тендеры в MacroERP
        • Аккредитация контрагентов
        • Возврат предложения на доработку
        • Категории тендеров
        • Неценовые критерии тендера
        • Проведение тендера в несколько этапов
        • Проверка службой безопасности при аккредитации
        • Просмотр предложений и выбор победителя
        • Редактирование тендера
        • Согласование тендера
        • Создание тендера из заказа на поставку ТМЦ
        • Список тендеров компании
        • Статусы тендера
        • Создание договора с победителем тендера
      • Настройки
        • Настройки тендерной площадки
        • Тип работы площадки
        • Установка площадки
    • Интеграции
      • Сайт компании
        • API Передача ключей
        • Интеграция с сайтом
        • Получение сделок контакта
        • Прием заявок с Creatium.io
        • Прием заявок с Tilda
      • Телефония
        • Интеграция с ВАТС (DSI) Деловая сеть — Иркутск. Телефония
        • Интеграция с ВАТС МТС Exolve
        • Интеграция с ВАТС Мегафон
        • Интеграция с ВАТС Callibri
        • Интеграция с ВАТС Sipuni
        • Интеграция с ВАТС Мои Звонки
        • Интеграция с ВАТС Авантел
        • Интеграция с ВАТС UIS
        • Интеграция с ВАТС OnlinePBX
        • Интеграция с ВАТС Дом.ру
        • Интеграция с АТС Aterisk (описание API)
        • Интеграция с АТС Aterisk (пример реализации)
        • Интеграция с ВАТС Манго office
        • Интеграция с ВАТС Ростелеком
        • Интеграция с ВАТС Телфин
        • Получение списка звонков
      • Отправка СМС
        • Интеграции c SMS-сервисом OCTOTELECOM
        • Интеграция с sms-prosto.ru
        • Интеграция с sms.ru
      • Мессенджеры
        • Интеграция с Wаzzup и WhatsApp
        • Интеграция с Wаzzup и Telegram
        • Подключение уведомлений в Telegram
        • Постановка задач через Telegram-бота
      • Маркетинг и аналитика
        • Интеграция с Callibri
        • Интеграция с Calltouch
        • Интеграция с CoMagic
        • Интеграция с Facebook и Instagram
        • Интеграция с Google Data Studio
        • Интеграция с Roistat
        • Интеграция с Webjack
        • Интеграция с CarrotQuest
      • Другие интеграции
        • Ai Chat
        • Инграфикон
        • JivoSite
        • API Вебхуков
        • Нмаркет.ПРО
      • Выгрузка на классифайды
        • Автоматическая выгрузка новостроек на ДомКлик
        • Конструктор фидов
      • 1С
        • Интеграция MACRO и 1С
        • Сделки
        • Форсированная синхронизация сущностей с 1С
      • Сбер
        • ЭСКРОУ
          • Инструкция по онлайн открытию эскроу счета в MacroCRM
          • Как выгрузить сертификат в pfx-контейнер
        • Ипотека Домклик
      • API 2.0
        • Приложения
      • Page
    • MacroData
      • MacroData - корпоративная аналитика для застройщиков
      • Инструкция по подключению PowerBI к MacroData
    • Ира - ЧатБот с ИИ
      • Как составить идеальный запрос для Иры: 6 ключевых составляющих
    • MacroBI
    • MacroMetrics
    • MacroSales
      • Заявки
        • Создание контакта
        • Агентства недвижимости и агенты
        • Процесс продаж
        • Создание заявки
        • Отправка клиенту подобранных вариантов
        • Добавление задачи
        • Добавление отчёта о встрече
        • Звонки
        • Лента событий
        • Очередь бронирования
      • Недвижимость
        • Создание группы домов
        • Создание дома
        • Редактирование дома
        • Шахматка дома
        • Бронирование объекта
        • Искусственное ограничение предложения объектов
        • Признак эксклюзива у объектов недвижимости
        • Служебные отметки в объектах
      • Отчёты
        • Воронка продаж
    • Глобальный поиск
  • 📨Техническая поддержка
  • 🆕Обновления и новости
    • 2025
      • Январь
      • Февраль
      • Март
      • Апрель
    • 2024
      • Декабрь
      • Ноябрь
      • Октябрь
      • Сентябрь
      • Август
      • Июль
      • Июнь
      • Май
      • Апрель
      • Март
      • Февраль
      • Январь
    • 2023
      • Октябрь
      • Ноябрь
      • Декабрь
Powered by GitBook
On this page
  1. Руководство пользователя
  2. Интеграции
  3. Маркетинг и аналитика

Интеграция с CarrotQuest

Инструкция по настройке Webhook CarrotQuest для интеграции с MacroCRM

Для специалистов CarrotQuest и тех, кто настраивает интеграцию CarrotQuest с MacroCRM

Данная инструкция описывает типы Webhook запросов, структуру данных, матрицу полей и API описание для интеграции CarrotQuest с MacroCRM.


4. Типы Webhook запросов

MacroCRM поддерживает два типа Webhook запросов от CarrotQuest:

  • TYPE_CLASSIC (event): Классический тип Webhook, отправляет данные о различных системных событиях, происходящих с пользователями на вашем сайте (просмотр страниц, изменение данных профиля, UTM инициализация и т.д.). Эти события инициируются системой CarrotQuest автоматически при определенных действиях пользователя.

  • TYPE_TRIGGER (message_webhook): Webhook, отправляемый при срабатывании триггеров в CarrotQuest. Эти триггеры могут быть настроены для срабатывания при определенных условиях, например, при заполнении формы в чате или при отправке сообщения через триггерное сообщение. Данный тип Webhook предназначен для передачи данных, собранных в рамках триггерных сценариев.

Важно! При настройке Webhook в CarrotQuest, необходимо выбрать, какой тип запросов будет отправляться в MacroCRM. Для полноценной интеграции лидов рекомендуется настроить отправку обоих типов Webhook запросов. TYPE_CLASSIC для отслеживания системных событий (например, UTM меток, изменений контактных данных), и TYPE_TRIGGER для получения данных из диалогов и форм, настроенных в триггерах CarrotQuest.

5. Структура данных Webhook запроса

5.1. Общая структура для обоих типов

Независимо от типа Webhook, запрос от CarrotQuest к MacroCRM представляет собой POST запрос в формате application/json. Основная структура данных для обоих типов включает следующие обязательные поля:

  • token: Строка токена для аутентификации запроса. Этот токен должен быть настроен как в CarrotQuest, так и в MacroCRM (в настройках интеграции CarrotQuest в MacroCRM).

  • type: Строка, указывающая тип Webhook запроса. Возможные значения: "event" (для TYPE_CLASSIC) или "message_webhook" (для TYPE_TRIGGER).

5.2. Структура данных для TYPE_CLASSIC (event)

Для Webhook типа event, данные об событии и пользователе передаются вложенными объектами event и user соответственно.

{
  "token": "your_webhook_token",
  "type": "event",
  "event": {
    "type": {
      "name": "[Название системного события]"  // Например, "$session_start", "$utm_hit", "$phone_changed"
    },
    "props": {
      // Объект со свойствами события, зависят от типа события
      // Например, для "$utm_hit": "$utm_campaign", "$utm_source", "$utm_medium", ...
      // Для "$phone_changed": "old_value", "new_value"
    },
    // ... другие поля объекта события (см. документацию CarrotQuest)
  },
  "user": {
    "id": "[ID пользователя в CarrotQuest]",
    "props": {
      "$phone": "[Номер телефона пользователя]",
      "$email": "[Email пользователя]",
      "$name": "[Имя пользователя]",
      "$initial_utm_campaign": "[UTM кампания]",
      "$initial_utm_source": "[UTM источник]",
      "$initial_utm_medium": "[UTM medium]",
      "$initial_utm_content": "[UTM content]",
      "$initial_utm_term": "[UTM term]",
      // ... другие свойства пользователя (см. документацию CarrotQuest)
    },
    // ... другие поля объекта пользователя (см. документацию CarrotQuest)
  }
}

Ключевые поля TYPE_CLASSIC:

  • event.type.name: Название системного события CarrotQuest. MacroCRM обрабатывает следующие системные события:

    • $utm_hit: Событие инициализации UTM меток при первом посещении сайта пользователем.

    • $phone_changed: Событие изменения номера телефона пользователя.

    • $email_changed: Событие изменения email пользователя.

  • event.props: Свойства события, специфичные для каждого типа системного события.

  • user.props: Свойства пользователя, включая контактные данные ($phone, $email, $name) и UTM метки, зафиксированные при первом посещении ($initial_utm_*).

5.3. Структура данных для TYPE_TRIGGER (message_webhook)

Для Webhook типа message_webhook (триггерные сообщения), данные передаются непосредственно в корне JSON объекта.

{
  "token": "your_webhook_token",
  "type": "message_webhook",
  "CarrotID": "[ID пользователя в CarrotQuest]",
  "Имя": "[Имя пользователя из формы триггера]",
  "Телефон": "[Номер телефона из формы триггера]",
  "email": "[Email из формы триггера]",
  "utmCampaign": "[UTM кампания]",
  "utmSource": "[UTM источник]",
  "utmMedium": "[UTM medium]",
  "utmContent": "[UTM content]",
  "utmTerm": "[UTM term]",
  "Комментарий CQ": "[Комментарий 1, настроенный в триггере]",
  "Комментарий CQ 2.0": "[Комментарий 2, настроенный в триггере]",
  // ... другие поля, добавленные в триггерном сообщении CarrotQuest
}

Ключевые поля TYPE_TRIGGER:

  • CarrotID: ID пользователя в CarrotQuest.

  • Имя, Телефон, email: Данные пользователя, собранные через форму в триггерном сообщении CarrotQuest. Названия полей соответствуют русскоязычным названиям, как показано в примере.

  • utmCampaign, utmSource, utmMedium, utmContent, utmTerm: UTM метки, если настроена их передача в триггерном сообщении. Важно! Названия UTM параметров в TYPE_TRIGGER отличаются от TYPE_CLASSIC (отсутствует префикс $initial_utm_).

  • Комментарий CQ, Комментарий CQ 2.0: Поля для передачи комментариев к лиду, которые могут быть добавлены в настройках триггерного сообщения CarrotQuest.

6. Матрица полей для настройки Webhook в CarrotQuest

Для обеспечения корректной интеграции и передачи данных из CarrotQuest в MacroCRM, особенно для TYPE_TRIGGER Webhook, необходимо согласовать названия полей в CarrotQuest с ожидаемыми полями в MacroCRM.

6.1. TYPE_CLASSIC (event) Webhook

Для системных событий (TYPE_CLASSIC), дополнительная настройка полей в CarrotQuest не требуется. CarrotQuest автоматически отправляет данные в предопределенном формате, который MacroCRM ожидает для системных событий.

6.2. TYPE_TRIGGER (message_webhook) Webhook (Триггерные сообщения)

При настройке триггерных сообщений в CarrotQuest, важно убедиться, что названия полей, используемые в триггере (особенно в формах), соответствуют следующей матрице, чтобы MacroCRM мог корректно распознать и обработать данные.

Поле в форме триггера CarrotQuest

Название поля в Webhook запросе (TYPE_TRIGGER)

Поле в MacroCRM (Лид)

Описание

Имя

Имя

name

Имя клиента

Телефон

Телефон

phone

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

Email

email

email

Email клиента

UTM кампания

utmCampaign

utm.utm_campaign

UTM кампания

UTM источник

utmSource

utm.utm_source

UTM источник

UTM medium

utmMedium

utm.utm_medium

UTM medium

UTM content

utmContent

utm.utm_content

UTM content

UTM term

utmTerm

utm.utm_term

UTM term

Комментарий CQ

Комментарий CQ

notes

Комментарий к лиду (заметка 1)

Комментарий CQ 2.0

Комментарий CQ 2.0

notes

Комментарий к лиду (заметка 2)

CarrotQuest ID (скрытое поле)

CarrotID

carrotquest_cid

ID пользователя в CarrotQuest (для связки)

Тип лида (скрытое поле)

(не передается явно)

type: 'living'

Тип лида (живой лид)

Активность (скрытое поле)

(не передается явно)

activity: 'buy'

Активность лида (покупка)

Источник (скрытое поле)

(не передается явно)

from_source: 'carrotquest'

Источник лида (CarrotQuest)

Рекомендации по настройке полей в триггерах CarrotQuest:

  • Используйте указанные названия полей в формах триггерных сообщений CarrotQuest (например, "Имя", "Телефон", "Email").

  • Для UTM меток, если необходимо их передавать через триггер, убедитесь, что названия полей в CarrotQuest соответствуют: utmCampaign, utmSource, utmMedium, utmContent, utmTerm.

  • Для комментариев, используйте поля с названиями "Комментарий CQ" и "Комментарий CQ 2.0", если требуется передавать комментарии к лиду из триггерных сообщений.

  • Скрытые поля: Поля "CarrotQuest ID", "Тип лида", "Активность", "Источник" не нужно добавлять в настройки триггера CarrotQuest. MacroCRM автоматически добавляет эти данные при обработке Webhook запроса типа TYPE_TRIGGER.

7. Описание API (с точки зрения MacroCRM)

Endpoint URL: [URL вашей MacroCRM]/api/web/carrotquest/[ID компании]/[Ключ безопасности]

HTTP Method: POST

Request Body Format: application/json

Request Body Parameters:

Для TYPE_CLASSIC (event)

{
  "token": "string", // Обязательный, токен для аутентификации
  "type": "string", // Обязательный, всегда "event"
  "event": {
    "type": {
      "name": "string" // Обязательный, название системного события (например, "$utm_hit", "$phone_changed")
    },
    "props": {
      // Объект, свойства события (зависит от типа события)
    },
    // ... другие поля объекта события (см. документацию CarrotQuest)
  },
  "user": {
    "id": "integer", // Обязательный, ID пользователя в CarrotQuest
    "props": {
      "$phone": "string", // Номер телефона пользователя
      "$email": "string", // Email пользователя
      "$name": "string", // Имя пользователя
      "$initial_utm_campaign": "string", // UTM кампания
      "$initial_utm_source": "string", // UTM источник
      "$initial_utm_medium": "string", // UTM medium
      "$initial_utm_content": "string", // UTM content
      "$initial_utm_term": "string", // UTM term
      // ... другие свойства пользователя
    },
    // ... другие поля объекта пользователя
  }
}

Для TYPE_TRIGGER (message_webhook)

{
  "token": "string", // Обязательный, токен для аутентификации
  "type": "string", // Обязательный, всегда "message_webhook"
  "CarrotID": "integer", // Обязательный, ID пользователя в CarrotQuest
  "Имя": "string", // Имя пользователя (из формы триггера)
  "Телефон": "string", // Телефон пользователя (из формы триггера)
  "email": "string", // Email пользователя (из формы триггера)
  "utmCampaign": "string", // UTM кампания
  "utmSource": "string", // UTM источник
  "utmMedium": "string", // UTM medium
  "utmContent": "string", // UTM content
  "utmTerm": "string", // UTM term
  "Комментарий CQ": "string", // Комментарий 1
  "Комментарий CQ 2.0": "string", // Комментарий 2
  // ... другие поля, настроенные в триггерном сообщении
}

Response Codes:

  • 200 OK: Успешная обработка Webhook запроса. MacroCRM возвращает JSON: {"success": true}.

  • [Error Code]: В случае ошибки (например, невалидный токен, невалидные данные пользователя). MacroCRM возвращает JSON: {"success": false, "error": "[Сообщение об ошибке]"}. Код ошибки HTTP может варьироваться в зависимости от типа ошибки.


Обратите внимание: Данный документ предназначен для специалистов, настраивающих интеграцию CarrotQuest с MacroCRM. При настройке Webhook в личном кабинете CarrotQuest, используйте данную инструкцию как руководство по типам запросов, структуре данных и необходимым названиям полей для обеспечения корректной передачи данных в MacroCRM.

Last updated 2 months ago

🎓