KWIGA справочный центр Сервисы, интеграции, API, Настройки проекта Глобальные настройки Использование переменных на проекте, список доступных переменных

Использование переменных на проекте, список доступных переменных

Статьи:

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


В этой статье:


Общая информация о переменных

Переменные - это удобный способ подставлять персонализированные данные в различные элементы вашего проекта. Они могут использоваться в таких местах:

1. Вебхуки в автоматизациях

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

  • в URL вебхука, например:
    https://example.com/hook?user={user.email}

  • в параметрах тела запроса

  • в заголовках

Это позволяет передавать персональные данные в сторонние сервисы автоматически.

2. CTA (Call to Action)

В кнопках и ссылках переменные можно использовать для:

  • персонализации текста кнопки

  • передачи данных через ссылки, например ID пользователя или UTM-метки

3. В параметрах

Переменные можно использовать в параметрах форм или других элементов:

  • email пользователя

  • ID подписки

  • уникальные коды и теги

  • любая другая переменная, доступная в контексте

4. В ссылке редиректа (если не используется переход на оплату)

Можно добавить переменные вручную в ссылку редиректа:

https://my.site.com/thanks?email={user.email}&course={course.title}

5. В инфоблоках уроков

Переменные работают внутри текстов инфоблоков. Например:

  • Обращение по имени: Привет, {user.first_name}!

  • Вывод названия курса, даты, статуса и т.д.

6. В письмах

Использование переменных в письмах позволяет сделать коммуникацию более персонализированной и эффективной. С помощью переменных, таких как {имя}, {дата} или {название курса} письмо выглядит персонально адресованным для клиента. Это повышает доверие, вовлеченность и вероятность того, что пользователь дочитает письмо до конца или выполнит нужное действие. Кроме того, переменные упрощают автоматизацию массовых рассылок без потери индивидуального подхода.

7. В уведомлениях

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

Список доступных переменных

Список доступных переменных, которые доступны во всех местах, где можно использовать переменные.

Переменная Значение
contact.id ID контакта
contact.user_id ID пользователя
contact.first_name Имя контакта
contact.last_name Фамилия контакта
contact.middle_name Отчество контакта
contact.name Полное имя контакта
contact.email Email контакта
contact.phone Телефон контакта
contact.country Страна контакта. Например: Украина
contact.timezone Часовой пояс контакта. Например: Europe/Kyiv
contact.currency Валюта контакта. Например: USD
contact.city Город контакта
contact.utm_source Список уникальных utm_source контакта (разделитель ", ")
contact.utm_medium Список уникальных utm_medium контакта (разделитель ", ")
contact.utm_campaign Список уникальных utm_campaign контакта (разделитель ", ")
contact.utm_term Список уникальных utm_term контакта (разделитель ", ")
contact.utm_content Список уникальных utm_content контакта (разделитель ", ")
contact.field_<id> Кастомные поля (описание ниже)
datetime Дата и время в UTC в формате YYYY-MM-DD HH:mm:ss
contact.visit_source Источник посещения

Кастомные поля

{contact.field_<id>}

Пример {contact.field_123}

<id> - id поля, которое можно получить в настройках полей контакта (пример https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

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

  • в параметрах

  • в ссылке редиректа (если не используется переход на оплату)

Переменная Значение
first_name Имя из заявки
last_name Фамилия из заявки
middle_name Отчество из заявки
name Полное имя из заявки
email Email из заявки
phone Телефон из заявки
field_<id> Кастомные поля Телефон из заявки (описание ниже)
utm_source utm_source - конкретно того посещения, с которого была оставлена заявка
utm_medium utm_medium - конкретно того посещения, с которого была оставлена заявка
utm_campaign utm_campaign - конкретно того посещения, с которого была оставлена заявка
utm_term utm_term - конкретно того посещения, с которого была оставлена заявка
utm_content utm_content - конкретно того посещения, с которого была оставлена заявка
widget_landing Url лендинга, с которого отправили заявку
widget_landign_referer Referer, который был на лендинге, когда отправили заявку

Также в определенных формах могут быть доступны переменные, описанные ниже в Переменных доступных в вебхуках автоматизации

По заказу ({order.*}) - Если выбран вариант формы Доступ к продукту (Полный доступ/По предложению)

По продукту({product.*}) - Если выбран вариант формы Доступ к продукту + Полный доступ

По предложению ({offer.*}) - Если выбран вариант формы Доступ к продукту + По предложению

Кастомные поля

{field_<id>}

Пример {field_123}

<id> - id поля, которое можно получить в настройках полей контакта (пример https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

Если на странице, где размещен CTA или скрипт Kwiga для трекинга посещений, были посещения с utm метками, и клиент оставил заявку на лендинге уже без utm меток, то в этих переменных они будут отсутствовать. Но они будут доступны в переменных {contact.utm_...}, которые описаны выше.

Переменные доступные в вебхуках автоматизации (url, параметры, письма)

Список доступных переменных

Переменная Значение
referrer Referrer с первого известного посещения контакта (Kwiga / лендинг с CTA)
initial_page Url первого известного посещения контакта (Kwiga / лендинг с CTA)
reg_from Url страницы, с которой произошла регистрация (Kwiga / лендинг с CTA)
tags Теги контакта (разделитель ", ")
description Описание события, по которому сработала автоматизация. Например: Контакту добавлен тег test_tag

Переменные CTA формы

Переменная Значение
cta.id ID CTA формы
cta.uuid UUID CTA формы
cta.title Название CTA формы
cta_request.form_data Список введенных пользователем данных (разделены переносами строк)
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Заявка CTA

Переменные продукта

Переменная Значение
product.id ID продукта
product.title Название продукта
product.productable_type Тип продукта. Могут быть такие варианты: course, webinar, closed_group, custom_product
product.productable_id ID курса/вебинара/закрытой группы/кастомного продукта

Доступны при срабатывании следующих событий:

  • Доступ к продукту открыт
  • Доступ к продукту закрыт
  • Зарегистрировался на вебинар
  • Курс завершен
  • Прохождение квиза
  • Аннулирование предыдущего результата квиза
  • Квиз перешел в статус
  • Старт доступа по подписке
  • Конец доступа по подписке
  • Начал смотреть урок
  • Посмотрел урок
  • Открыт доступ к уроку
  • Вся практика на уроке пройдена

Переменные заказа

Переменная Значение
order.id ID заказа
order.price Финальная цена. Пример 10.99
order.currency_code Валюта заказа в кодовом формате. Пример: USD
order.currency_symbol Валюта заказа в формате символа. Пример: $
order.currency_short_title Валюта заказа в сокращенном названии. Пример: usd
order.order_stage_id ID статуса воронки
order.order_stage_title Название статуса воронки
order.funnel_id ID воронки
order.funnel_title Название воронки
order.paid_status Статус оплаты заказа not_paid / partial_paid / paid
order.paid_status_title Статус оплаты словами на английском
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Подписка начата
  • Подписка продлена
  • Успешная оплата заказа
  • Новый заказ
  • Успешная оплата предложения
  • Неуспешная оплата предложения
  • Возврат платежа по предложению
  • Доступ к продукту открыт
  • Старт доступа по подписке
  • Конец доступа по подписке

Переменные платежа

Переменная Значение
payment.id ID платежа
payment.price Цена платежа
payment.currency_code Валюта платежа в кодовом формате. Пример: USD
payment.currency_symbol Валюта платежа в формате символа. Пример: $
payment.currency_short_title Валюта платежа в сокращенном названии. Пример: usd
payment.created_at Дата создания платежа. Формат YYYY-MM-DD HH:mm:ss
payment.paid_at Дата оплаты. Формат YYYY-MM-DD HH:mm:ss
payment.schedule_payment_at Запланированная дата оплаты. Формат YYYY-MM-DD HH:mm:ss
payment.number Порядковый номер платежа в заказе
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Успешная оплата предложения
  • Неуспешная оплата предложения
  • Возврат платежа по предложению

Переменные предложения

Переменная Значение
offer.id ID предложения
offer.title Название предложения
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Успешная оплата предложения
  • Неуспешная оплата предложения
  • Возврат платежа по предложению
  • Принято бесплатное предложение
  • Подписка начата
  • Подписка продлена
  • Успешная оплата заказа
  • Новый заказ
  • Доступ к продукту открыт
  • Старт доступа по подписке
  • Конец доступа по подписке

Переменные подписки на продукт

Переменная Значение
subscription.id ID подписки на продукт
subscription.start_at Дата начала подписки. YYYY-MM-DD HH:mm:ss
subscription.end_at Финальная дата окончания подписки. YYYY-MM-DD HH:mm:ss
subscription.order_end_at Дата окончания подписки, учитывая только оплаченные платежи. YYYY-MM-DD HH:mm:ss
subscription.paid_at Дата первой оплаты подписки. YYYY-MM-DD HH:mm:ss
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Доступ к продукту открыт
  • Старт доступа по подписке
  • Конец доступа по подписке

Переменные попытки прохождения квиза

Переменная Значение
quiz_attempt.id ID попытки
quiz_attempt.number_version Номер версии прохождения
quiz_attempt.quiz_id ID квиза
quiz_attempt.course_id ID курса
quiz_attempt.course_lesson_id ID урока
quiz_attempt.status_id ID статуса
quiz_attempt.status Статус в текстовом виде
quiz_attempt.scores Набрано баллов
quiz_attempt.created_at Начало попытки. Формат YYYY-MM-DD HH:mm:ss
quiz_attempt.finished_at Конец попытки. Формат YYYY-MM-DD HH:mm:ss
quiz_attempt.count_questions Количество вопросов в квизе
quiz_attempt.count_questions_incorrect Количество вопросов, на которые неправильно ответили
quiz_attempt.count_questions_correct Количество правильно отвеченных вопросов
quiz.title Название квиза
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Прохождение квиза
  • Аннулирование предыдущего результата квиза
  • Квиз перешел в статус

Переменные урока

Переменная Значение
lesson.id ID урока
lesson.title Название урока
Список может дополняться.

Доступны при срабатывании следующих событий:

  • Прохождение квиза
  • Аннулирование предыдущего результата квиза
  • Квиз перешел в статус
  • Начал смотреть урок
  • Посмотрел урок
  • Открыт доступ к уроку
  • Вся практика на уроке пройдена