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>}

Приклад {contact.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 Назва уроку
Список може доповнюватися.

Доступні при спрацьовуванні наступних подій:

  • Проходження квіза
  • Скасування попереднього результату квіза
  • Квіз перейшов в статус
  • Почав дивитися урок
  • Подивився урок
  • Відкритий доступ до уроку
  • Вся практика на уроці пройдена