KWIGA centrum nápovědy Služby, integrace, API, Nastavení Obecné nastavení Používání proměnných v projektu, seznam dostupných proměnných

Používání proměnných v projektu, seznam dostupných proměnných

Články:

Tento článek vysvětluje, jak používat proměnné ve vašem projektu — kde je uplatnit, jaká data jsou dostupná a jak je využít pro automatizaci a personalizaci. Obsahuje seznam s popisy a příklady pro e-maily, webhooky, tlačítka, lekce a další.


V tomto článku:


Obecné informace o proměnných

Proměnné jsou pohodlný způsob, jak vkládat personalizovaná data do různých prvků vašeho projektu. Mohou být použity na těchto místech:

1. Webhooky v automatizacích

Proměnné lze vkládat:

  • v URL webhooku, například:
    https://example.com/hook?user={user.email}

  • v parametrech těla žádosti

  • v záhlaví

To umožňuje automaticky předávat osobní údaje do externích služeb.

2. CTA (Call to Action)

V tlačítkách a odkazech lze proměnné použít pro:

  • personalizaci textu tlačítka

  • předávání dat přes odkazy, například ID uživatele nebo UTM značky

3. V parametrech

Proměnné lze použít v parametrech formulářů nebo jiných prvků:

  • email uživatele

  • ID předplatného

  • unikátní kódy a značky

  • jakákoli jiná proměnná dostupná v kontextu

4. V odkazu přesměrování (pokud se nepoužívá přechod na platbu)

Proměnné lze ručně přidat do odkazu přesměrování:

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

5. V infoblocích lekcí

Proměnné fungují uvnitř textů infoblocích. Například:

  • Oslovení jménem: Ahoj, {user.first_name}!

  • Zobrazení názvu kurzu, data, stavu atd.

6. V e-mailech

Použití proměnných v e-mailech umožňuje učinit komunikaci více personalizovanou a efektivní. Pomocí proměnných, jako jsou {jméno}, {datum} nebo {název kurzu}, e-mail vypadá osobně adresovaný klientovi. To zvyšuje důvěru, zapojení a pravděpodobnost, že uživatel dočte e-mail do konce nebo provede požadovanou akci. Kromě toho proměnné usnadňují automatizaci hromadných rozesílek bez ztráty individuálního přístupu.

7. V oznámeních

Při nastavování oznámení v automatizačních akcích umožňují proměnné dynamicky vkládat informace do oznámení, například jméno uživatele, číslo objednávky nebo název nabídky. To zjednodušuje a urychluje proces vytváření oznámení, činí je intuitivnějšími a přizpůsobivějšími pro různé scénáře.

Seznam dostupných proměnných

Seznam dostupných proměnných, které jsou dostupné na všech místech, kde lze použít proměnné.

Proměnná Hodnota
contact.id ID kontaktu
contact.user_id ID uživatele
contact.first_name Jméno kontaktu
contact.last_name Příjmení kontaktu
contact.middle_name Prostřední jméno kontaktu
contact.name Celé jméno kontaktu
contact.email Email kontaktu
contact.phone Telefon kontaktu
contact.country Země kontaktu. Například: Ukrajina
contact.timezone Časové pásmo kontaktu. Například: Europe/Kyiv
contact.currency Měna kontaktu. Například: USD
contact.city Město kontaktu
contact.utm_source Seznam unikátních utm_source kontaktu (oddělovač ", ")
contact.utm_medium Seznam unikátních utm_medium kontaktu (oddělovač ", ")
contact.utm_campaign Seznam unikátních utm_campaign kontaktu (oddělovač ", ")
contact.utm_term Seznam unikátních utm_term kontaktu (oddělovač ", ")
contact.utm_content Seznam unikátních utm_content kontaktu (oddělovač ", ")
contact.field_<id> Vlastní pole (popis níže)
datetime Datum a čas v UTC ve formátu YYYY-MM-DD HH:mm:ss
contact.visit_source Zdroj návštěvy

Vlastní pole

{contact.field_<id>}

Příklad {contact.field_123}

<id> - id pole, které lze získat v nastavení polí kontaktu (příklad https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

Proměnné, které lze dodatečně použít v CTA

  • v parametrech

  • v odkazu přesměrování (pokud se nepoužívá přechod na platbu)

Proměnná Hodnota
first_name Jméno z žádosti
last_name Příjmení z žádosti
middle_name Prostřední jméno z žádosti
name Celé jméno z žádosti
email Email z žádosti
phone Telefon z žádosti
field_<id> Vlastní pole Telefon z žádosti (popis níže)
utm_source utm_source - konkrétně té návštěvy, ze které byla podána žádost
utm_medium utm_medium - konkrétně té návštěvy, ze které byla podána žádost
utm_campaign utm_campaign - konkrétně té návštěvy, ze které byla podána žádost
utm_term utm_term - konkrétně té návštěvy, ze které byla podána žádost
utm_content utm_content - konkrétně té návštěvy, ze které byla podána žádost
widget_landing Url vstupní stránky, ze které byla odeslána žádost
widget_landign_referer Referer, který byl na vstupní stránce, když byla odeslána žádost

Také v určitých formulářích mohou být dostupné proměnné, popsané níže v Proměnných dostupných ve webhookách automatizace

Podle objednávky ({order.*}) - Pokud je vybrána varianta formuláře Přístup k produktu (Plný přístup/Podle nabídky)

Podle produktu({product.*}) - Pokud je vybrána varianta formuláře Přístup k produktu + Plný přístup

Podle nabídky ({offer.*}) - Pokud je vybrána varianta formuláře Přístup k produktu + Podle nabídky

Vlastní pole

{field_<id>}

Příklad {contact.field_123}

<id> - id pole, které lze získat v nastavení polí kontaktu (příklad https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

Pokud na stránce, kde je umístěn CTA nebo skript Kwiga pro sledování návštěv, byly návštěvy s utm značkami, a klient zanechal žádost na landing page již bez utm značek, pak v těchto proměnných budou chybět. Ale budou dostupné v proměnných {contact.utm_...}, které jsou popsány výše.

Proměnné dostupné ve webhooks automatizace (url, parametry, e-maily)

Seznam dostupných proměnných

Proměnná Hodnota
referrer Referrer z první známé návštěvy kontaktu (Kwiga / vstupní stránka s CTA)
initial_page Url první známé návštěvy kontaktu (Kwiga / vstupní stránka s CTA)
reg_from Url stránky, ze které došlo k registraci (Kwiga / vstupní stránka s CTA)
tags Tagy kontaktu (oddělovač ", ")
description Popis události, která spustila automatizaci. Například: Kontaktu byl přidán tag test_tag

Proměnné CTA formuláře

Proměnná Hodnota
cta.id ID CTA formuláře
cta.uuid UUID CTA formuláře
cta.title Název CTA formuláře
cta_request.form_data Seznam uživatelských dat (oddělených novými řádky)
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Žádost CTA

Proměnné produktu

Proměnná Hodnota
product.id ID produktu
product.title Název produktu
product.productable_type Typ produktu. Mohou být takové varianty: course, webinar, closed_group, custom_product
product.productable_id ID kurzu/webináře/uzavřené skupiny/vlastního produktu

Dostupné při spuštění následujících událostí:

  • Přístup k produktu získán
  • Přístup k produktu odebrán
  • Registrován k webináři
  • Kurz dokončen
  • Kvíz splněn
  • Výsledek kvízu resetován
  • Kvíz přešel na stav
  • Začátek přístupu z předplatného
  • Konec přístupu z předplatného
  • Začal sledovat lekci
  • Lekce sledována
  • Otevřen přístup k lekci
  • Dokončena všechna cvičení v lekci

Proměnné objednávky

Proměnná Hodnota
order.id ID objednávky
order.price Konečná cena. Příklad 10.99
order.currency_code Měna objednávky v kódovém formátu. Příklad: USD
order.currency_symbol Měna objednávky ve formátu symbolu. Příklad: $
order.currency_short_title Měna objednávky ve zkráceném názvu. Příklad: usd
order.order_stage_id ID stavu trychtýře
order.order_stage_title Název stavu trychtýře
order.funnel_id ID trychtýře
order.funnel_title Název trychtýře
order.paid_status Stav platby objednávky not_paid / partial_paid / paid
order.paid_status_title Stav platby slovy v angličtině
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Předplatné zahájeno
  • Předplatné prodlouženo
  • Zaplacená objednávka
  • Nová objednávka
  • Platba za nabídku úspěšná
  • Platba za nabídku selhala
  • Vrácení platby za nabídku
  • Přístup k produktu získán
  • Začátek přístupu z předplatného
  • Konec přístupu z předplatného

Proměnné platby

Proměnná Hodnota
payment.id ID platby
payment.price Cena platby
payment.currency_code Měna platby v kódovém formátu. Příklad: USD
payment.currency_symbol Měna platby ve formátu symbolu. Příklad: $
payment.currency_short_title Měna platby ve zkráceném názvu. Příklad: usd
payment.created_at Datum vytvoření platby. Formát YYYY-MM-DD HH:mm:ss
payment.paid_at Datum platby. Formát YYYY-MM-DD HH:mm:ss
payment.schedule_payment_at Plánované datum platby. Formát YYYY-MM-DD HH:mm:ss
payment.number Pořadové číslo platby v objednávce
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Platba za nabídku úspěšná
  • Platba za nabídku selhala
  • Vrácení platby za nabídku

Proměnné nabídky

Proměnná Hodnota
offer.id ID nabídky
offer.title Název nabídky
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Platba za nabídku úspěšná
  • Platba za nabídku selhala
  • Vrácení platby za nabídku
  • Přijata bezplatná nabídka
  • Předplatné zahájeno
  • Předplatné prodlouženo
  • Zaplacená objednávka
  • Nová objednávka
  • Přístup k produktu získán
  • Začátek přístupu z předplatného
  • Konec přístupu z předplatného

Proměnné předplatného na produkt

Proměnná Hodnota
subscription.id ID předplatného produktu
subscription.start_at Datum začátku předplatného. YYYY-MM-DD HH:mm:ss
subscription.end_at Konečné datum ukončení předplatného. YYYY-MM-DD HH:mm:ss
subscription.order_end_at Datum ukončení předplatného, zohledňující pouze zaplacené platby. YYYY-MM-DD HH:mm:ss
subscription.paid_at Datum první platby předplatného. YYYY-MM-DD HH:mm:ss
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Přístup k produktu získán
  • Začátek přístupu z předplatného
  • Konec přístupu z předplatného

Proměnné pokusu o absolvování kvízu

Proměnná Hodnota
quiz_attempt.id ID pokusu
quiz_attempt.number_version Číslo verze průchodu
quiz_attempt.quiz_id ID kvízu
quiz_attempt.course_id ID kurzu
quiz_attempt.course_lesson_id ID lekce
quiz_attempt.status_id ID statusu
quiz_attempt.status Status v textové podobě
quiz_attempt.scores Získané body
quiz_attempt.created_at Začátek pokusu. Formát YYYY-MM-DD HH:mm:ss
quiz_attempt.finished_at Konec pokusu. Formát YYYY-MM-DD HH:mm:ss
quiz_attempt.count_questions Počet otázek v kvízu
quiz_attempt.count_questions_incorrect Počet otázek, na které bylo odpovězeno nesprávně
quiz_attempt.count_questions_correct Počet správně zodpovězených otázek
quiz.title Název kvízu
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Kvíz splněn
  • Výsledek kvízu resetován
  • Kvíz přešel na stav

Proměnné lekce

Proměnná Hodnota
lesson.id ID lekce
lesson.title Název lekce
Seznam může být doplněn.

Dostupné při spuštění následujících událostí:

  • Kvíz splněn
  • Výsledek kvízu resetován
  • Kvíz přešel na stav
  • Začal sledovat lekci
  • Lekce sledována
  • Otevřen přístup k lekci
  • Dokončena všechna cvičení v lekci