Central de ajuda KWIGA Serviços, integrações, API, Configurações Configurações gerais Uso de variáveis no projeto, lista de variáveis disponíveis

Uso de variáveis no projeto, lista de variáveis disponíveis

Artigos:

Este artigo explica como utilizar variáveis no seu projeto — onde aplicá-las, quais dados estão disponíveis e como usá-las para automação e personalização. Inclui uma lista com descrições e exemplos para e-mails, webhooks, botões, aulas e muito mais.


Neste artigo:


Informações gerais sobre variáveis

Variáveis são uma maneira conveniente de inserir dados personalizados em vários elementos do seu projeto. Elas podem ser usadas nos seguintes locais:

1. Webhooks em automações

As variáveis podem ser inseridas:

  • no URL do webhook, por exemplo:
    https://example.com/hook?user={user.email}

  • nos parâmetros do corpo da solicitação

  • nos cabeçalhos

Isso permite enviar dados pessoais para serviços de terceiros automaticamente.

2. CTA (Call to Action)

Em botões e links, as variáveis podem ser usadas para:

  • personalizar o texto do botão

  • transmitir dados através de links, como ID do usuário ou tags UTM

3. Nos parâmetros

As variáveis podem ser usadas em parâmetros de formulários ou outros elementos:

  • email do usuário

  • ID da assinatura

  • códigos únicos e tags

  • qualquer outra variável disponível no contexto

4. No link de redirecionamento (se não for usado para pagamento)

Você pode adicionar variáveis manualmente no link de redirecionamento:

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

5. Nos blocos de informação das aulas

As variáveis funcionam dentro dos textos dos blocos de informação. Por exemplo:

  • Saudação pelo nome: Olá, {user.first_name}!

  • Exibição do nome do curso, data, status, etc.

6. Nos emails

O uso de variáveis nos emails permite tornar a comunicação mais personalizada e eficaz. Com variáveis como {nome}, {data} ou {nome do curso}, o email parece pessoalmente direcionado ao cliente. Isso aumenta a confiança, o engajamento e a probabilidade de o usuário ler o email até o fim ou realizar a ação desejada. Além disso, as variáveis simplificam a automação de envios em massa sem perder o toque individual.

7. Nas notificações

Ao configurar notificações em ações de automação, as variáveis permitem inserir dinamicamente informações nas notificações, como nome de usuário, número do pedido ou nome da oferta. Isso simplifica e acelera o processo de criação de notificações, tornando-as mais intuitivas e adaptáveis para diferentes cenários.

Lista de variáveis disponíveis

Lista de variáveis disponíveis em todos os locais onde as variáveis podem ser usadas.

Variável Valor
contact.id ID do contato
contact.user_id ID do usuário
contact.first_name Nome do contato
contact.last_name Sobrenome do contato
contact.middle_name Nome do meio do contato
contact.name Nome completo do contato
contact.email Email do contato
contact.phone Telefone do contato
contact.country País do contato. Por exemplo: Ucrânia
contact.timezone Fuso horário do contato. Por exemplo: Europe/Kyiv
contact.currency Moeda do contato. Por exemplo: USD
contact.city Cidade do contato
contact.utm_source Lista de utm_source únicos do contato (separador ", ")
contact.utm_medium Lista de utm_medium únicos do contato (separador ", ")
contact.utm_campaign Lista de utm_campaign únicos do contato (separador ", ")
contact.utm_term Lista de utm_term únicos do contato (separador ", ")
contact.utm_content Lista de utm_content únicos do contato (separador ", ")
contact.field_<id> Campos personalizados (descrição abaixo)
datetime Data e hora em UTC no formato YYYY-MM-DD HH:mm:ss
contact.visit_source Fonte da visita

Campos personalizados

{contact.field_<id>}

Exemplo {contact.field_123}

<id> - id do campo que pode ser obtido nas configurações dos campos de contato (exemplo https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

Variáveis que podem ser usadas adicionalmente em CTA

  • nos parâmetros

  • no link de redirecionamento (se não for usado para pagamento)

Variável Valor
first_name Nome do pedido
last_name Sobrenome do pedido
middle_name Nome do meio do pedido
name Nome completo do pedido
email Email do pedido
phone Telefone do pedido
field_<id> Campos personalizados Telefone do pedido (descrição abaixo)
utm_source utm_source - especificamente da visita em que o pedido foi feito
utm_medium utm_medium - especificamente da visita em que o pedido foi feito
utm_campaign utm_campaign - especificamente da visita em que o pedido foi feito
utm_term utm_term - especificamente da visita em que o pedido foi feito
utm_content utm_content - especificamente da visita em que o pedido foi feito
widget_landing Url da landing page de onde o pedido foi enviado
widget_landign_referer Referer que estava na landing page quando o pedido foi enviado

Também em determinados formulários podem estar disponíveis variáveis, descritas abaixo em Variáveis disponíveis nos webhooks de automação

Por pedido ({order.*}) - Se a opção de formulário Acesso ao produto (Acesso total/Por oferta) for selecionada

Por produto({product.*}) - Se a opção de formulário Acesso ao produto + Acesso total for selecionada

Por oferta ({offer.*}) - Se a opção de formulário Acesso ao produto + Por oferta for selecionada

Campos personalizados

{field_<id>}

Exemplo {contact.field_123}

<id> - id do campo que pode ser obtido nas configurações dos campos de contato (exemplo https://sampleschool.kwiga.com/expert/crm/contacts?view=settings)

Custom fields example

Se na página onde o CTA ou script Kwiga para rastreamento de visitas estiverem, houver visitas com tags utm, e o cliente fizer uma solicitação na landing page já sem as tags utm, então nessas variáveis elas estarão ausentes. Mas estarão disponíveis nas variáveis {contact.utm_...}, que estão descritas acima.

Variáveis disponíveis em webhooks de automação (url, parâmetros, emails)

Lista de variáveis disponíveis

Variável Valor
referrer Referer da primeira visita conhecida do contato (Kwiga / landing com CTA)
initial_page Url da primeira visita conhecida do contato (Kwiga / landing com CTA)
reg_from Url da página onde o registro foi feito (Kwiga / landing com CTA)
tags Tags do contato (separador ", ")
description Descrição do evento que acionou a automação. Por exemplo: Tag test_tag adicionada ao contato

Variáveis CTA do formulário

Variável Valor
cta.id ID do CTA do formulário
cta.uuid UUID do CTA do formulário
cta.title Nome do CTA do formulário
cta_request.form_data Lista de dados inseridos pelo usuário (separados por quebras de linha)
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Solicitação CTA

Variáveis de produto

Variável Valor
product.id ID do produto
product.title Nome do produto
product.productable_type Tipo de produto. Podem ser: course, webinar, closed_group, custom_product
product.productable_id ID do curso/webinar/grupo fechado/produto personalizado

Disponível ao disparar os seguintes eventos:

  • Acesso ao produto concedido
  • Acesso ao produto removido
  • Registrado no webinar
  • Curso concluído
  • Questionário concluído
  • Resultado do questionário redefinido
  • Questionário alterado para status
  • Início de acesso por assinatura
  • Término de acesso por assinatura
  • Começou a assistir à aula
  • Assistiu à aula
  • Abrir acesso à aula
  • Todas as práticas da aula concluídas

Variáveis de pedido

Variável Valor
order.id ID do pedido
order.price Preço final. Exemplo 10.99
order.currency_code Moeda do pedido em formato de código. Exemplo: USD
order.currency_symbol Moeda do pedido em formato de símbolo. Exemplo: $
order.currency_short_title Moeda do pedido em nome abreviado. Exemplo: usd
order.order_stage_id ID do status do funil
order.order_stage_title Nome do status do funil
order.funnel_id ID do funil
order.funnel_title Nome do funil
order.paid_status Status de pagamento do pedido not_paid / partial_paid / paid
order.paid_status_title Status de pagamento em palavras em inglês
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Assinatura iniciada
  • Assinatura renovada
  • Pedido pago
  • Novo pedido
  • Pagamento de oferta bem-sucedido
  • Pagamento de oferta falhou
  • Reembolso de pagamento de oferta
  • Acesso ao produto concedido
  • Início de acesso por assinatura
  • Término de acesso por assinatura

Variáveis de pagamento

Variável Valor
payment.id ID do pagamento
payment.price Preço do pagamento
payment.currency_code Moeda do pagamento em formato de código. Exemplo: USD
payment.currency_symbol Moeda do pagamento em formato de símbolo. Exemplo: $
payment.currency_short_title Moeda do pagamento em nome abreviado. Exemplo: usd
payment.created_at Data de criação do pagamento. Formato YYYY-MM-DD HH:mm:ss
payment.paid_at Data de pagamento. Formato YYYY-MM-DD HH:mm:ss
payment.schedule_payment_at Data de pagamento planejada. Formato YYYY-MM-DD HH:mm:ss
payment.number Número sequencial do pagamento no pedido
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Pagamento de oferta bem-sucedido
  • Pagamento de oferta falhou
  • Reembolso de pagamento de oferta

Variáveis de oferta

Variável Valor
offer.id ID da oferta
offer.title Nome da oferta
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Pagamento de oferta bem-sucedido
  • Pagamento de oferta falhou
  • Reembolso de pagamento de oferta
  • Aceitou oferta gratuita
  • Assinatura iniciada
  • Assinatura renovada
  • Pedido pago
  • Novo pedido
  • Acesso ao produto concedido
  • Início de acesso por assinatura
  • Término de acesso por assinatura

Variáveis de assinatura de produto

Variável Valor
subscription.id ID de assinatura do produto
subscription.start_at Data de início da assinatura. YYYY-MM-DD HH:mm:ss
subscription.end_at Data final de término da assinatura. YYYY-MM-DD HH:mm:ss
subscription.order_end_at Data de término da assinatura, considerando apenas os pagamentos efetuados. YYYY-MM-DD HH:mm:ss
subscription.paid_at Data do primeiro pagamento da assinatura. YYYY-MM-DD HH:mm:ss
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Acesso ao produto concedido
  • Início de acesso por assinatura
  • Término de acesso por assinatura

Variáveis de tentativa de quiz

Variável Valor
quiz_attempt.id ID da tentativa
quiz_attempt.number_version Número da versão do progresso
quiz_attempt.quiz_id ID do quiz
quiz_attempt.course_id ID do curso
quiz_attempt.course_lesson_id ID da lição
quiz_attempt.status_id ID do status
quiz_attempt.status Status em texto
quiz_attempt.scores Pontos obtidos
quiz_attempt.created_at Início da tentativa. Formato YYYY-MM-DD HH:mm:ss
quiz_attempt.finished_at Fim da tentativa. Formato YYYY-MM-DD HH:mm:ss
quiz_attempt.count_questions Número de perguntas no quiz
quiz_attempt.count_questions_incorrect Número de perguntas respondidas incorretamente
quiz_attempt.count_questions_correct Número de perguntas respondidas corretamente
quiz.title Nome do quiz
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Questionário concluído
  • Resultado do questionário redefinido
  • Questionário alterado para status

Variáveis de aula

Variável Valor
lesson.id ID da lição
lesson.title Nome da lição
A lista pode ser complementada.

Disponível ao disparar os seguintes eventos:

  • Questionário concluído
  • Resultado do questionário redefinido
  • Questionário alterado para status
  • Começou a assistir à aula
  • Assistiu à aula
  • Abrir acesso à aula
  • Todas as práticas da aula concluídas