Significado da variável dos templates

Documentação de Variáveis dos Templates


Índice




Introdução


Este documento contém a documentação completa de todas as variáveis disponíveis no sistema de templates de notificação do Notificações Inteligentes. As variáveis são utilizadas para personalizar mensagens enviadas via WhatsApp com informações dinâmicas de pedidos, clientes, produtos e outros dados das integrações.


Arquivos Fonte


  • Definições: lang/pt-BR/enums.php (seção variables)
  • Exemplos: lang/variables-example.json
  • Processamento: src/Services/MustacheRenderWithHelpers.php



Sistema Mustache


O sistema utiliza Mustache.php como engine de templates. Mustache é um sistema de templates "logic-less" que utiliza tags simples.


Sintaxe Básica


{{ variable.name }}


Nota: O @ é utilizado para escapar a sintaxe Mustache dentro de templates Blade do Laravel.


Interpolação de Variáveis


Olá {{ customer.first_name }}, seu pedido #{{ order.id }} foi aprovado!


Seções Condicionais


Exibe conteúdo apenas se a variável existir e não for nula:


{{# pix.bacen_code }}
Código PIX: {{ pix.bacen_code }}
{{/ pix.bacen_code }}


Operador Raw (URLs)


Para variáveis que contêm URLs, use & para evitar escape HTML:


Acesse seu boleto: {{& billet.url }}



Helpers Customizados


O sistema disponibiliza helpers especiais para formatação de valores. Os helpers são funções que envolvem variáveis para aplicar transformações.


Formatação de Texto


ucfirst

Converte a primeira letra para maiúscula e o restante para minúsculas.


{{# ucfirst }}{{ customer.first_name }}{{/ ucfirst }}

Exemplo: joão → João


toupper

Converte todo o texto para maiúsculas.


{{# toupper }}{{ customer.first_name }}{{/ toupper }}

Exemplo: joão → JOÃO


Formatação de Moeda


currency_br

Formata valores monetários no padrão brasileiro (R$ 1.234,56).


Total: {{# currency_br }}{{ pricing.total }}{{/ currency_br }}

Exemplo: 141.16 → R$ 141,16


currency_eur

Formata valores monetários em euros (€ 1,234.56).


Total: {{# currency_eur }}{{ pricing.total }}{{/ currency_eur }}

Exemplo: 141.16 → € 141.16


currency_usd

Formata valores monetários em dólares americanos (US$ 1,234.56).


Total: {{# currency_usd }}{{ pricing.total }}{{/ currency_usd }}

Exemplo: 141.16 → US$ 141.16


Formatação de Data


date_br

Formata datas no padrão brasileiro (dd/mm/yyyy).


Data do pedido: {{# date_br }}{{ order.created_at }}{{/ date_br }}

Exemplo: 2019-12-08 12:30:00 → 08/12/2019


date_us

Formata datas no padrão americano (mm/dd/yyyy).


Order date: {{# date_us }}{{ order.created_at }}{{/ date_us }}

Exemplo: 2019-12-08 12:30:00 → 12/08/2019


date_inter

Formata datas no padrão internacional (yyyy/mm/dd).


Date: {{# date_inter }}{{ order.created_at }}{{/ date_inter }}

Exemplo: 2019-12-08 12:30:00 → 2019/12/08


datetime_br

Formata data e hora no padrão brasileiro com fuso horário de São Paulo.


Pedido realizado em: {{# datetime_br }}{{ order.created_at }}{{/ datetime_br }}

Exemplo: 2019-12-08 12:30:00 → 08/12/2019 12:30 (Horário de Brasília)


Formatação de Telefone


phone_inter

Formata telefone no padrão internacional E.164.


Contato: {{# phone_inter }}{{ customer.phone }}{{/ phone_inter }}

Exemplo: 31991111111 → +5531991111111


phone_national

Formata telefone no padrão nacional.


Telefone: {{# phone_national }}{{ customer.phone }}{{/ phone_national }}

Exemplo: +5531991111111 → (31) 99111-1111


Saudação Dinâmica


greetings

Retorna saudação baseada no horário atual (horário de Brasília).


{{# greetings }}{{/ greetings }}, {{ customer.first_name }}!
  • 00:00 - 11:59: Bom dia
  • 12:00 - 17:59: Boa tarde
  • 18:00 - 23:59: Boa noite



Operadores Especiais


Sistema de Randomização


Escolhe aleatoriamente uma das opções separadas por ||:


[[Olá || Oi || E aí]], {{ customer.first_name }}!


Operador OR (Fallback)


Utiliza a primeira variável disponível que não seja nula ou vazia:


{{ customer.first_name || customer.full_name || "Cliente" }}


Também aceita valores literais entre aspas:


{{ order.cancel_reason || "Motivo não informado" }}



Variáveis por Grupo


Access


Variáveis relacionadas a credenciais de acesso e autenticação em áreas de membros, cursos ou plataformas.


Variável

Tipo

Descrição Completa

Exemplo

access.code

String

Código alfanumérico único gerado para acesso à plataforma. Geralmente utilizado em áreas de membros que requerem um código de ativação ou primeiro acesso.

ABCACDE2F0690G3TDEF

access.first_access_url

URL

Link completo para a página de primeiro acesso do usuário. Utilizado quando o cliente precisa configurar sua conta pela primeira vez, geralmente inclui token de autenticação na URL.

https://acesso.com/primeiro-acesso/abc-123-abc-123

access.login

String

Nome de usuário ou email usado para login na plataforma. Pode ser o email do cliente ou um username customizado gerado pelo sistema.

joao@da.silva

access.password

String

Senha gerada automaticamente para o primeiro acesso do usuário. IMPORTANTE: Deve ser tratada com segurança e o usuário deve ser instruído a alterá-la após o primeiro login.

ABC12345

access.url

URL

Link direto para a página de login da área de membros ou plataforma de curso. Utilizado para direcionar o cliente à tela de autenticação.

https://acesso.com/login


Exemplo de uso:

🔐 *Seus dados de acesso foram gerados!*

Login: {{ access.login }}
Senha: {{ access.password }}

{{# access.first_access_url }}
Primeiro acesso: {{& access.first_access_url }}
{{/ access.first_access_url }}

Acesse a plataforma: {{& access.url }}

⚠️ Por segurança, altere sua senha após o primeiro login.



Address


Variáveis relacionadas ao endereço principal do cliente. Utilizado para endereço de cadastro, cobrança ou entrega quando não há distinção específica.


Variável

Tipo

Descrição Completa

Exemplo

address.country

String

Código do país no formato ISO 3166-1 alpha-2 (2 letras). Representa o país do endereço cadastrado.

BR

address.city

String

Nome da cidade do endereço. Informação essencial para cálculo de frete e validação de entrega.

Betim

address.complement

String

Complemento do endereço incluindo bloco, apartamento, sala, referências adicionais. Pode estar vazio se não fornecido.

BL1 AP2

address.neighborhood

String

Nome do bairro ou distrito. Utilizado para melhor localização e cálculo de frete em algumas regiões.

Centro

address.number

String

Número do imóvel no logradouro. Pode conter valores como "S/N" para endereços sem número.

1234

address.postal_code

String

Código postal (CEP no Brasil) formatado com hífen. Essencial para cálculo de frete e validação de endereço.

12345-123

address.state

String

Código da unidade federativa (estado) com 2 letras. No Brasil, sigla do estado (UF).

MG

address.street

String

Nome completo do logradouro incluindo tipo (Rua, Avenida, Travessa, etc).

Avenida Amazonas


Exemplo de uso:

📍 *Endereço cadastrado:*

{{ address.street }}, {{ address.number }}
{{# address.complement }}{{ address.complement }}{{/ address.complement }}
{{ address.neighborhood }}
{{ address.city }} - {{ address.state }}
CEP: {{ address.postal_code }}



Address Pickup


Variáveis relacionadas ao endereço de retirada de produtos. Utilizado quando o cliente opta por retirar o pedido em loja física ou ponto de retirada.


Variável

Tipo

Descrição Completa

Exemplo

address_pickup.country

String

Código do país no formato ISO 3166-1 alpha-2 do local de retirada.

BR

address_pickup.city

String

Cidade onde está localizado o ponto de retirada do pedido.

Betim

address_pickup.complement

String

Complemento do endereço de retirada, como informações de estacionamento, entrada específica ou ponto de referência.

BL1 AP2

address_pickup.neighborhood

String

Bairro onde está localizado o ponto de retirada.

Centro

address_pickup.number

String

Número do estabelecimento onde o pedido deve ser retirado.

1234

address_pickup.postal_code

String

CEP do local de retirada formatado.

12345-123

address_pickup.state

String

Sigla do estado onde está o ponto de retirada.

MG

address_pickup.street

String

Logradouro completo do ponto de retirada.

Avenida Amazonas


Exemplo de uso:

🏪 *Local de retirada do pedido:*

{{ address_pickup.street }}, {{ address_pickup.number }}
{{ address_pickup.neighborhood }}
{{ address_pickup.city }} - {{ address_pickup.state }}
CEP: {{ address_pickup.postal_code }}

{{# address_pickup.complement }}
Observações: {{ address_pickup.complement }}
{{/ address_pickup.complement }}



Billing Address


Variáveis do endereço de cobrança. Utilizado quando o endereço para emissão de nota fiscal ou cobrança é diferente do endereço de entrega.


Variável

Tipo

Descrição Completa

Exemplo

billing_address.country

String

País do endereço de cobrança. Importante para transações internacionais e emissão de documentos fiscais.

BR

billing_address.city

String

Cidade do endereço de cobrança utilizado para emissão de nota fiscal.

Betim

billing_address.complement

String

Complemento do endereço de cobrança.

BL1 AP2

billing_address.neighborhood

String

Bairro do endereço de cobrança.

Centro

billing_address.number

String

Número do endereço de cobrança.

1234

billing_address.postal_code

String

CEP do endereço de cobrança.

12345-123

billing_address.state

String

Estado do endereço de cobrança.

MG

billing_address.street

String

Logradouro do endereço de cobrança.

Avenida Amazonas


Exemplo de uso:

💳 *Endereço de cobrança:*

{{ billing_address.street }}, {{ billing_address.number }}
{{ billing_address.city }} - {{ billing_address.state }}
CEP: {{ billing_address.postal_code }}



Shipping Address


Variáveis do endereço de entrega. Utilizado quando há distinção clara entre endereço de cobrança e entrega.


Variável

Tipo

Descrição Completa

Exemplo

shipping_address.country

String

País de destino da entrega.

BR

shipping_address.city

String

Cidade de destino para entrega do pedido. Utilizado para cálculo de prazo e custo de frete.

Betim

shipping_address.complement

String

Complemento do endereço de entrega com informações adicionais para o entregador.

BL1 AP2

shipping_address.neighborhood

String

Bairro de destino da entrega.

Centro

shipping_address.number

String

Número do local de entrega.

1234

shipping_address.postal_code

String

CEP de destino. Fundamental para rastreamento e cálculo de frete.

12345-123

shipping_address.state

String

Estado de destino da entrega.

MG

shipping_address.street

String

Logradouro completo do endereço de entrega.

Avenida Amazonas


Exemplo de uso:

📦 *Endereço de entrega:*

{{ shipping_address.street }}, {{ shipping_address.number }}
{{# shipping_address.complement }}{{ shipping_address.complement }}{{/ shipping_address.complement }}
{{ shipping_address.neighborhood }}
{{ shipping_address.city }} - {{ shipping_address.state }}
CEP: {{ shipping_address.postal_code }}



Bill


Variáveis relacionadas a faturas de serviços ou cobranças recorrentes (diferentes de boletos bancários).


Variável

Tipo

Descrição Completa

Exemplo

bill.id

String

Identificador único da fatura no sistema. Utilizado para referência e consultas.

12345

bill.url

URL

Link para visualização online da fatura. Permite que o cliente acesse detalhes e histórico.

https://nota-fiscal.com/12345

bill.url_pdf

URL

Link direto para download da fatura em formato PDF.

https://fatura/pdf/12345

bill.status

String

Status atual da fatura. Valores comuns: "Pago", "Aberta", "Vencida", "Cancelada".

Pago


Exemplo de uso:

🧾 *Fatura #{{ bill.id }}*

Status: {{ bill.status }}

{{# bill.url }}
Ver fatura: {{& bill.url }}
{{/ bill.url }}

{{# bill.url_pdf }}
Download PDF: {{& bill.url_pdf }}
{{/ bill.url_pdf }}



Billet


Variáveis relacionadas a boletos bancários para pagamento.


Variável

Tipo

Descrição Completa

Exemplo

billet.barcode

String

Código de barras numérico do boleto formatado com espaços. Utilizado para pagamento em caixas eletrônicos e agências bancárias.

12345 12345 12345 1 12345

billet.due_date

DateTime

Data de vencimento do boleto no formato ISO. Importante para alertas de vencimento próximo.

2020-09-10 00:00:00

billet.shorten_url

URL

Link encurtado do boleto através do serviço vermeusboletos.com para facilitar compartilhamento.

https://vermeusboletos.com.br/12345

billet.url

URL

Link completo para visualização online do boleto. Permite que o cliente veja e imprima o boleto.

https://boleto.com/12345

billet.pdf_url

URL

Link direto para download do boleto em formato PDF.

https://boleto.com/12345

billet.value

Number

Valor total do boleto em formato decimal. Use helper currency_br para formatação.

123.45


Exemplo de uso:

🧾 *Boleto bancário gerado*

Valor: {{# currency_br }}{{ billet.value }}{{/ currency_br }}
Vencimento: {{# date_br }}{{ billet.due_date }}{{/ date_br }}

📱 Link curto: {{& billet.shorten_url }}
🖨️ PDF: {{& billet.pdf_url }}

Código de barras:
`{{ billet.barcode }}`



Cashback


Variáveis relacionadas a programas de cashback e devolução de valores em compras.


Variável

Tipo

Descrição Completa

Exemplo

cashback.balance

Number

Saldo atual disponível de cashback que o cliente pode utilizar em próximas compras.

0.68

cashback.code

String

Código do cupom de cashback que deve ser aplicado no checkout para usar o saldo.

cbcode

cashback.used

Number

Valor de cashback utilizado na compra atual.

1.23

cashback.due_date

DateTime

Data de expiração do cashback. Após esta data o saldo é perdido.

2025-12-08 00:00:00

cashback.percent

Number

Porcentagem de cashback que foi ou será concedida na compra.

10

cashback.release_date

DateTime

Data em que o cashback ficará disponível para uso. Alguns programas têm período de carência.

2025-12-08 00:00:00

cashback.status

String

Status da transação de cashback. Valores: "approved" (aprovado), "pending" (pendente), "cancelled" (cancelado).

approved

cashback.minimum_value

Number

Valor mínimo de compra necessário para utilizar o cashback acumulado.

101.0

cashback.minimum_value_to_withdraw_all

Number

Valor mínimo de compra para poder utilizar todo o saldo de cashback de uma vez.

101.0


Exemplo de uso:

💰 *Cashback disponível!*

Saldo: {{# currency_br }}{{ cashback.balance }}{{/ currency_br }}

{{# cashback.code }}
Cupom: `{{ cashback.code }}`
{{/ cashback.code }}

{{# cashback.due_date }}
Válido até: {{# date_br }}{{ cashback.due_date }}{{/ date_br }}
{{/ cashback.due_date }}

{{# cashback.minimum_value }}
Valor mínimo de compra: {{# currency_br }}{{ cashback.minimum_value }}{{/ currency_br }}
{{/ cashback.minimum_value }}



Certificate


Variáveis relacionadas a certificados de conclusão de cursos ou treinamentos.


Variável

Tipo

Descrição Completa

Exemplo

certificate.url

URL

Link para visualização ou download do certificado digital. Geralmente em formato PDF ou página web personalizada.

https://certificado.url/12345


Exemplo de uso:

🎓 *Parabéns pela conclusão!*

Seu certificado está disponível:
{{& certificate.url }}



Checkout


Variáveis relacionadas à página de checkout e processo de compra.


Variável

Tipo

Descrição Completa

Exemplo

checkout.id

String

Identificador único do checkout criado. Utilizado para rastreamento e recuperação de carrinhos abandonados.

12345

checkout.customer_id

String

Identificador do cliente associado ao checkout.

123456

checkout.url

URL

Link direto para a página de checkout onde o cliente pode finalizar a compra. Útil para recuperação de carrinho abandonado.

https://checkout.url/12345


Exemplo de uso:

🛒 *Checkout iniciado!*

Complete sua compra:
{{& checkout.url }}

Código do checkout: {{ checkout.id }}



Conversion


Variáveis relacionadas a conversões e vendas concluídas.


Variável

Tipo

Descrição Completa

Exemplo

conversion.id

String

Número identificador da conversão ou venda concluída.

1

conversion.status

String

Situação do processo de conversão. Valores comuns: "confirmed" (confirmada), "pending" (pendente), "cancelled" (cancelada).

confirmed


Exemplo de uso:

✅ *Conversão confirmada!*

ID: #{{ conversion.id }}
Status: {{ conversion.status }}



Credit Card


Variáveis relacionadas a pagamentos com cartão de crédito.


Variável

Tipo

Descrição Completa

Exemplo

credit_card.access_code

String

Código alfanumérico gerado para acessar ou gerenciar o método de pagamento cadastrado. Utilizado em algumas plataformas para atualização de cartão.

123456ASJKOSJA12315465


Exemplo de uso:

💳 *Código de acesso ao cartão:*

`{{ credit_card.access_code }}`

Use este código para gerenciar seu método de pagamento.



Cryptocurrency


Variáveis relacionadas a pagamentos com criptomoedas.


Variável

Tipo

Descrição Completa

Exemplo

cryptocurrency.due_date

DateTime

Data limite para realizar a transferência de criptomoedas. Após este período a cotação pode mudar.

2019-12-08 00:00:00

cryptocurrency.qrcode

URL

Link para visualizar o QR Code que contém o endereço da carteira para pagamento.

https://loja.com/qrcode/12345

cryptocurrency.type_currency

String

Tipo de criptomoeda aceita para o pagamento (Bitcoin, Ethereum, Dogecoin, etc).

DOGECOIN

cryptocurrency.value

Number

Valor da transação em unidades de criptomoeda. Atenção: não é o valor em moeda fiduciária.

0.0066

cryptocurrency.wallet_address

String

Endereço da carteira de destino para onde a criptomoeda deve ser enviada.

1S2D3F5G6T555Y41HJ456


Exemplo de uso:

₿ *Pagamento com criptomoeda*

Moeda: {{ cryptocurrency.type_currency }}
Valor: {{ cryptocurrency.value }} {{ cryptocurrency.type_currency }}

Endereço da carteira:
`{{ cryptocurrency.wallet_address }}`

QR Code: {{& cryptocurrency.qrcode }}

{{# cryptocurrency.due_date }}
Válido até: {{# datetime_br }}{{ cryptocurrency.due_date }}{{/ datetime_br }}
{{/ cryptocurrency.due_date }}



Customer


Variáveis detalhadas sobre o cliente que realizou a compra ou cadastro.


Variável

Tipo

Descrição Completa

Exemplo

customer.birthdate

Date

Data de nascimento do cliente no formato ISO. Útil para campanhas de aniversário.

1990-01-01

customer.cpf_cnpj

String

CPF (pessoa física) ou CNPJ (pessoa jurídica) do cliente sem formatação especial.

91006434089

customer.currency

String

Código da moeda preferencial do cliente no formato ISO 4217 (3 letras).

BRL

customer.email

String

Endereço de email principal do cliente.

joao@da.silva

customer.first_name

String

Primeiro nome do cliente. Ideal para comunicações mais pessoais e próximas.

João

customer.full_name

String

Nome completo do cliente incluindo todos os nomes e sobrenomes.

João da Silva

customer.gender

String

Gênero do cliente. Valores comuns: "M" (masculino), "F" (feminino), "O" (outro), "NI" (não informado).

M

customer.last_name

String

Sobrenome ou último nome do cliente.

da Silva

customer.phone

String

Número de telefone do cliente no formato internacional E.164.

+5531991111111


Exemplo de uso:

👤 *Dados do cliente:*

Nome: {{ customer.full_name }}
CPF/CNPJ: {{ customer.cpf_cnpj }}
Email: {{ customer.email }}
Telefone: {{# phone_national }}{{ customer.phone }}{{/ phone_national }}

{{# customer.birthdate }}
Data de nascimento: {{# date_br }}{{ customer.birthdate }}{{/ date_br }}
{{/ customer.birthdate }}



Date


Variáveis relacionadas a datas do sistema.


Variável

Tipo

Descrição Completa

Exemplo

date.now

DateTime

Data e hora atual no momento do envio da notificação. Útil para timestamps e mensagens contextuais.

2019-12-08 00:00:00


Exemplo de uso:

Notificação enviada em {{# datetime_br }}{{ date.now }}{{/ datetime_br }}



Event


Variáveis relacionadas ao evento que disparou a notificação.


Variável

Tipo

Descrição Completa

Exemplo

event.name

String

Nome legível do evento que disparou a notificação (ex: "Pagamento Aprovado", "Pedido Enviado").

Pagamento Aprovado

event.store.name

String

Nome da integração ou loja que gerou o evento.

Notificações Inteligentes


Exemplo de uso:

📢 Evento: *{{ event.name }}*
Integração: {{ event.store.name }}



Exam


Variáveis relacionadas a avaliações e provas em plataformas de ensino.


Variável

Tipo

Descrição Completa

Exemplo

exam.answers

Number

Número total de questões respondidas corretamente pelo aluno.

7

exam.errors

Number

Número total de questões respondidas incorretamente.

4

exam.minimum_score

Number

Nota mínima necessária para aprovação na avaliação.

7

exam.name

String

Nome ou título da avaliação realizada.

Prova de matemática

exam.score

Number

Nota final obtida pelo aluno na avaliação.

7


Exemplo de uso:

📝 *Resultado da avaliação*

Prova: {{ exam.name }}
Nota: {{ exam.score }}/{{ exam.minimum_score }}

✅ Acertos: {{ exam.answers }}
❌ Erros: {{ exam.errors }}

{{# exam.score >= exam.minimum_score }}
🎉 Parabéns! Você foi aprovado!
{{/ exam.score >= exam.minimum_score }}



Field


Variáveis customizadas específicas de cada integração.


Variável

Tipo

Descrição Completa

Exemplo

field.name

String

Nome da variável customizada configurada especificamente na integração. O conteúdo varia conforme configuração.

Produto


Exemplo de uso:

Campo customizado: {{ field.name }}



Fidelity


Variáveis relacionadas a programas de fidelidade e pontos.


Variável

Tipo

Descrição Completa

Exemplo

fidelity.discount_percentage

Number

Porcentagem de desconto concedida através do programa de fidelidade.

10

fidelity.cashback_balance

Number

Saldo disponível de cashback no programa de fidelidade em valor monetário.

5

fidelity.coupon

String

Código do cupom de desconto gerado pelo programa de fidelidade.

1s2s2s2s2s2s

fidelity.expiring_points

Number

Quantidade de pontos que irão expirar em breve. Útil para campanhas de retenção.

1000

fidelity.points

Number

Pontos ganhos na transação atual.

1000

fidelity.points_balance

Number

Total de pontos acumulados e disponíveis no programa.

1000

fidelity.spent_points

Number

Pontos que foram utilizados/gastos na compra atual.

500


Exemplo de uso:

⭐ *Programa de Fidelidade*

Pontos ganhos: {{ fidelity.points }}
Saldo total: {{ fidelity.points_balance }} pontos

{{# fidelity.coupon }}
Cupom de desconto: `{{ fidelity.coupon }}`
Desconto: {{ fidelity.discount_percentage }}%
{{/ fidelity.coupon }}

{{# fidelity.expiring_points }}
⚠️ {{ fidelity.expiring_points }} pontos vão expirar em breve!
{{/ fidelity.expiring_points }}



Invoice


Variáveis relacionadas a notas fiscais (NF-e, NFS-e).


Variável

Tipo

Descrição Completa

Exemplo

invoice.id

String

Identificador único da nota fiscal no sistema emissor.

12345

invoice.status

String

Status atual da nota fiscal. Valores: "Autorizada", "Cancelada", "Denegada", "Processando".

Pago

invoice.url

URL

Link para consulta online da nota fiscal no sistema da SEFAZ ou emissor.

https://nota-fiscal.com/12345

invoice.url_pdf

URL

Link direto para download da DANFE (Documento Auxiliar da Nota Fiscal Eletrônica) em PDF.

https://nota-fiscal.com/12345.pdf

invoice.key

String

Chave de acesso de 44 dígitos da NF-e. Utilizada para consulta na SEFAZ e validação.

12345678912340000123450010000123456789123456

invoice.code

String

Número da nota fiscal com 6 dígitos.

012345

invoice.series

String

Número de série da nota fiscal. Geralmente 1 para a maioria das empresas.

1

invoice.confirmation_url

URL

URL para confirmação de recebimento ou consulta adicional da nota fiscal.

https://teste.com

invoice.total_value

String

Valor total da nota fiscal formatado.

123.45


Exemplo de uso:

📄 *Nota Fiscal emitida*

NF-e: {{ invoice.code }} / Série: {{ invoice.series }}
Status: {{ invoice.status }}
Valor: R$ {{ invoice.total_value }}

Chave de acesso:
`{{ invoice.key }}`

📥 Download: {{& invoice.url_pdf }}
🔍 Consultar: {{& invoice.url }}



Invitee


Variáveis relacionadas a convites e agendamentos de reuniões (Calendly, Google Calendar, etc).


Variável

Tipo

Descrição Completa

Exemplo

invitee.cancel_url

URL

Link para cancelamento do agendamento pelo convidado.

https://invitee.com/12345

invitee.reschedule_url

URL

Link para remarcar o horário do agendamento.

https://invitee.com/12345

invitee.location

String

Local onde a reunião acontecerá. Pode ser endereço físico ou link de videoconferência.

Betim, MG

invitee.status

String

Status do convite. Valores: "created" (criado), "confirmed" (confirmado), "cancelled" (cancelado), "rescheduled" (remarcado).

created

invitee.join_url

URL

Link direto para acessar a reunião online (Zoom, Meet, Teams, etc).

https://invitee.com/12345

invitee.start_time

DateTime

Data e horário de início da reunião agendada.

2019-12-08 12:30:00


Exemplo de uso:

📅 *Reunião agendada!*

Data: {{# datetime_br }}{{ invitee.start_time }}{{/ datetime_br }}
Local: {{ invitee.location }}
Status: {{ invitee.status }}

{{# invitee.join_url }}
🔗 Entrar na reunião: {{& invitee.join_url }}
{{/ invitee.join_url }}

Gerenciar agendamento:
• Remarcar: {{& invitee.reschedule_url }}
• Cancelar: {{& invitee.cancel_url }}



Lead


Variáveis sobre leads ou potenciais clientes em funis de vendas.


Variável

Tipo

Descrição Completa

Exemplo

lead.currency

String

Código da moeda no formato ISO 4217 associada ao lead.

BRL

lead.email

String

Email do lead para comunicação.

joao@da.silva

lead.first_name

String

Primeiro nome do lead.

João

lead.full_name

String

Nome completo do lead.

João da Silva

lead.last_name

String

Sobrenome do lead.

da Silva

lead.phone

String

Telefone de contato do lead no formato E.164.

+5531991111111


Exemplo de uso:

🎯 *Novo lead capturado!*

Nome: {{ lead.full_name }}
Email: {{ lead.email }}
Telefone: {{# phone_national }}{{ lead.phone }}{{/ phone_national }}



Lesson


Variáveis relacionadas a aulas em plataformas de ensino (EAD).


Variável

Tipo

Descrição Completa

Exemplo

lesson.name

String

Título ou nome da aula/lição.

Aula de matemática

lesson.percentage_completed

Number

Porcentagem de conclusão da aula (0-100). Útil para notificar progresso.

100

lesson.session

String

Nome da sessão ou módulo ao qual a aula pertence.

Sessão de Aula


Exemplo de uso:

📚 *Progresso na aula*

Aula: {{ lesson.name }}
Módulo: {{ lesson.session }}
Progresso: {{ lesson.percentage_completed }}%

{{# lesson.percentage_completed == 100 }}
✅ Aula concluída!
{{/ lesson.percentage_completed == 100 }}



Order


Variáveis completas sobre pedidos e transações.


Variável

Tipo

Descrição Completa

Exemplo

order.id

String

Código único do pedido ou transação no sistema. Identificador principal.

12345

order.order_id

String

Número do pedido visível para o cliente. Pode ser diferente do ID interno.

12345

order.reference_id

String

Código de referência alternativo do pedido. Utilizado para integração com sistemas externos.

12345

order.status

String

Situação atual do pedido. Valores comuns: "Aguardando Pagamento", "Pago", "Enviado", "Entregue", "Cancelado", "Reembolsado".

Pago

order.checkout_url

URL

Link para retornar ao checkout do pedido. Útil para pagamentos pendentes.

https://urlteste.com.br

order.digital_attachment

URL

Link para download de produtos digitais (e-books, cursos, softwares).

https://urlteste.com.br

order.payment_method

String

Forma de pagamento utilizada. Valores: "pix", "credit_card", "billet", "debit_card", etc.

pix

order.thank_you_page

URL

Link para página de agradecimento pós-compra. Pode conter upsells ou conteúdo adicional.

https://thankyoupage.com.br

order.feedback_url

URL

Link para página de avaliação da compra ou produto.

https://feedback.com.br

order.created_at

DateTime

Data e hora em que o pedido foi criado no sistema.

2019-12-08 12:30:00

order.paid_at

DateTime

Data e hora da confirmação do pagamento. Pode ser nula para pedidos ainda não pagos.

2019-12-08 12:30:00

order.cancel_reason

String

Motivo do cancelamento do pedido informado pelo cliente ou sistema.

Motivos financeiros


Exemplo de uso:

🛍️ *Pedido #{{ order.order_id }}*

Status: {{ order.status }}
Pagamento: {{ order.payment_method }}

{{# order.created_at }}
Realizado em: {{# datetime_br }}{{ order.created_at }}{{/ datetime_br }}
{{/ order.created_at }}

{{# order.paid_at }}
Pago em: {{# datetime_br }}{{ order.paid_at }}{{/ datetime_br }}
{{/ order.paid_at }}

{{# order.digital_attachment }}
📥 Download: {{& order.digital_attachment }}
{{/ order.digital_attachment }}

{{# order.thank_you_page }}
Acesse: {{& order.thank_you_page }}
{{/ order.thank_you_page }}



Payment


Variáveis gerais sobre pagamentos.


Variável

Tipo

Descrição Completa

Exemplo

payment.url

URL

Link para página de pagamento ou confirmação. Direciona o cliente para completar ou verificar o pagamento.

https://boleto.com/12345


Exemplo de uso:

💳 *Link de pagamento:*
{{& payment.url }}



Pix


Variáveis relacionadas a pagamentos via PIX.


Variável

Tipo

Descrição Completa

Exemplo

pix.bacen_code

String

Código PIX "copia e cola" completo gerado pelo Banco Central. Longo código alfanumérico que pode ser copiado para pagar.

00020101021126440014br.gov.bcb.pix...

pix.due_date

DateTime

Data de vencimento do PIX. Após esta data o QR Code pode expirar.

2019-12-08 00:00:00

pix.image_url

URL

URL direta da imagem do QR Code do PIX. Pode ser embutida em emails ou exibida em páginas.

https://vermeupix.com.br/qrcode?size=400&...

pix.qrcode

URL

Link para página que exibe o QR Code do PIX para escaneamento.

https://loja.com/qrcode/12345

pix.shorten_url

URL

Link encurtado utilizando o serviço vermeupix.com para facilitar compartilhamento.

https://vermeupix.com.br/12345/12345

pix.tutorial_url

URL

Link para tutorial ou página explicativa de como copiar e colar o código PIX.

https://loja.com/generate/12345

pix.url

URL

Link principal para visualizar informações completas do pagamento PIX.

https://loja.com/qrcode/12345

pix.value

Number

Valor exato a ser pago via PIX. Use helper currency_br para formatação.

141.16


Exemplo de uso:

💚 *Pagamento via PIX*

Valor: {{# currency_br }}{{ pix.value }}{{/ currency_br }}

{{# pix.due_date }}
Válido até: {{# datetime_br }}{{ pix.due_date }}{{/ datetime_br }}
{{/ pix.due_date }}

📱 *Link curto:*
{{& pix.shorten_url }}

📋 *Código copia e cola:*
```{{ pix.bacen_code }}


{{# pix.tutorial_url }}

❓ Como pagar: {{& pix.tutorial_url }}

{{/ pix.tutorial_url }}

---

### Pricing

Variáveis relacionadas aos valores e precificação do pedido.

| Variável | Tipo | Descrição Completa | Exemplo |
|----------|------|-------------------|---------|
| `pricing.discount` | Number | Valor total de desconto aplicado ao pedido (cupons, promoções, etc). | `10.05` |
| `pricing.products` | Number | Valor total dos produtos antes de aplicar frete e descontos. Subtotal dos produtos. | `141.22` |
| `pricing.shipping` | Number | Valor do frete/entrega. Pode ser zero para frete grátis. | `9.99` |
| `pricing.shipping_discount` | Number | Desconto aplicado especificamente no valor do frete. | `9.99` |
| `pricing.total` | Number | Valor total final do pedido já com todos os descontos e acréscimos aplicados. Valor a pagar. | `141.16` |

**Exemplo de uso:**
```mustache
💰 *Resumo do pedido:*

Produtos: {{# currency_br }}{{ pricing.products }}{{/ currency_br }}
Frete: {{# currency_br }}{{ pricing.shipping }}{{/ currency_br }}

{{# pricing.discount }}
Desconto: -{{# currency_br }}{{ pricing.discount }}{{/ currency_br }}
{{/ pricing.discount }}

{{# pricing.shipping_discount }}
Desconto frete: -{{# currency_br }}{{ pricing.shipping_discount }}{{/ currency_br }}
{{/ pricing.shipping_discount }}

*Total: {{# currency_br }}{{ pricing.total }}{{/ currency_br }}*



Products


Variáveis relacionadas aos produtos do pedido. ATENÇÃO: Esta é uma variável de array/lista.


Variável

Tipo

Descrição Completa

Exemplo

products.*.name

String

Nome do produto conforme cadastrado no sistema.

Bola de futebol

products.*.quantity

Number

Quantidade de unidades do produto no pedido.

1

products.*.value

Number

Valor unitário do produto. Use helper currency_br para formatação.

45.91

products.*.addons_description

String

Descrição de complementos, variações ou personalizações do produto (tamanho, cor, gravação personalizada, etc).

Numeração: 40


Exemplo de uso com iteração:

🛍️ *Produtos do pedido:*

{{# products }}
• {{ name }}
  Qtd: {{ quantity }}x
  Valor: {{# currency_br }}{{ value }}{{/ currency_br }}
  {{# addons_description }}
  Obs: {{ addons_description }}
  {{/ addons_description }}

{{/ products }}


Exemplo acessando primeiro produto:

Produto principal: {{ products.0.name }}



Prospection


Variáveis relacionadas a prospecções comerciais (CRM, vendas).


Variável

Tipo

Descrição Completa

Exemplo

prospection.status

String

Status atual do processo de prospecção. Valores: "Em andamento", "Ganho", "Perdido", "Aguardando", etc.

Perdido

prospection.lost_reason

String

Motivo pelo qual a prospecção foi perdida. Importante para análise de conversão.

Não tenho interesse


Exemplo de uso:

📊 Status da prospecção: {{ prospection.status }}

{{# prospection.lost_reason }}
Motivo: {{ prospection.lost_reason }}
{{/ prospection.lost_reason }}



Questions and Answers


Variáveis relacionadas a perguntas e respostas de formulários ou eventos. ATENÇÃO: Esta é uma variável de array/lista.


Variável

Tipo

Descrição Completa

Exemplo

questions_and_answers.*.question

String

Texto da pergunta realizada pelo organizador do evento ou formulário.

Seu nome?

questions_and_answers.*.position

Number

Número sequencial da pergunta (começando em 0). Útil para ordenação.

0

questions_and_answers.*.answer

String

Resposta fornecida pelo usuário/cliente.

José da Silva


Exemplo de uso com iteração:

📋 *Respostas do formulário:*

{{# questions_and_answers }}
{{ position }}. {{ question }}
R: {{ answer }}

{{/ questions_and_answers }}



Reset Password


Variáveis relacionadas a recuperação de senha.


Variável

Tipo

Descrição Completa

Exemplo

reset_password.url

URL

Link único e temporário para redefinir a senha. Geralmente expira após algumas horas por segurança.

https://meusite.com/redefinir-senha


Exemplo de uso:

🔐 *Recuperação de senha*

Clique no link abaixo para redefinir sua senha:
{{& reset_password.url }}

⚠️ Este link expira em 24 horas.



Review


Variáveis relacionadas a avaliações e reviews de produtos/serviços.


Variável

Tipo

Descrição Completa

Exemplo

review.url

URL

Link para página onde o cliente pode deixar sua avaliação ou review do produto/serviço.

https://review.url/12345


Exemplo de uso:

⭐ *Avalie sua compra!*

Sua opinião é muito importante para nós.
Deixe sua avaliação: {{& review.url }}



Shipping


Variáveis relacionadas ao envio e rastreamento de entregas.


Variável

Tipo

Descrição Completa

Exemplo

shipping.code

String

Código de rastreamento do pacote fornecido pela transportadora.

BR123456789AB

shipping.estimate

DateTime

Data estimada de entrega do pedido.

2019-12-08 12:30:00

shipping.estimate_days

Number

Número de dias úteis estimados para entrega a partir do envio.

7

shipping.id

Number

Identificador único do envio no sistema.

1

shipping.message

String

Mensagem mais recente da transportadora sobre a situação do pacote.

Objeto entregue ao destinatário

shipping.title

String

Nome da transportadora ou tipo de envio (Correios, Sedex, PAC, transportadora particular).

Correios

shipping.url

URL

Link para rastreamento online do pacote no site da transportadora.

https://correios.rastreamento/BR123456789AB

shipping.happened_at

DateTime

Data e hora da última movimentação registrada do pacote.

2019-12-08 12:30:00

shipping.posting_address

String

Endereço completo do local de postagem onde o pacote deve ser enviado (para casos de envio pelo cliente).

Avenida Amazonas, 1234, Betim, MG

shipping.locker_code

String

Código do armário/locker inteligente onde o pacote foi depositado para retirada.

123456


Exemplo de uso:

📦 *Atualização de envio*

Transportadora: {{ shipping.title }}
Código de rastreamento: `{{ shipping.code }}`

Status: {{ shipping.message }}
{{# shipping.happened_at }}
Atualizado em: {{# datetime_br }}{{ shipping.happened_at }}{{/ datetime_br }}
{{/ shipping.happened_at }}

{{# shipping.estimate }}
Previsão de entrega: {{# date_br }}{{ shipping.estimate }}{{/ date_br }}
{{/ shipping.estimate }}

{{# shipping.url }}
🔍 Rastreie seu pedido: {{& shipping.url }}
{{/ shipping.url }}

{{# shipping.locker_code }}
🔑 Código do locker: {{ shipping.locker_code }}
{{/ shipping.locker_code }}



Stock


Variáveis relacionadas a estoque e disponibilidade de produtos.


Variável

Tipo

Descrição Completa

Exemplo

stock.purchase_url

URL

Link direto para a página de compra do produto. Útil para notificações de reposição de estoque.

https://link-da-loja/produto/92


Exemplo de uso:

✅ *Produto de volta ao estoque!*

O produto que você desejava está disponível novamente.
Compre agora: {{& stock.purchase_url }}



Store


Variáveis relacionadas à loja ou integração.


Variável

Tipo

Descrição Completa

Exemplo

store.name

String

Nome da loja ou integração configurada no sistema.

Loja do Sebastião

store.id

String

Identificador único da loja no sistema.

12345


Exemplo de uso:

🏪 Loja: {{ store.name }}



Subscription


Variáveis relacionadas a assinaturas recorrentes.


Variável

Tipo

Descrição Completa

Exemplo

subscription.id

String

Código único da assinatura no sistema.

12345

subscription.cycle

Number

Número do ciclo atual da assinatura (1 para primeira cobrança, 2 para segunda, etc).

1

subscription.name

String

Nome do plano de assinatura ou produto recorrente.

Plano Mensal

subscription.next_payment_attempt

Timestamp

Timestamp Unix da próxima tentativa de cobrança da assinatura.

1644518539

subscription.cancel_at

Timestamp

Timestamp Unix de quando a assinatura foi agendada para cancelamento. Se nulo, assinatura está ativa.

1644518539

subscription.cancel_reason

String

Motivo do cancelamento da assinatura informado pelo cliente.

Motivos financeiros


Exemplo de uso:

🔄 *Assinatura: {{ subscription.name }}*

ID: #{{ subscription.id }}
Ciclo: {{ subscription.cycle }}

{{# subscription.next_payment_attempt }}
Próxima cobrança: {{# date_br }}{{ subscription.next_payment_attempt }}{{/ date_br }}
{{/ subscription.next_payment_attempt }}

{{# subscription.cancel_at }}
⚠️ Cancelamento agendado para: {{# date_br }}{{ subscription.cancel_at }}{{/ date_br }}
{{/ subscription.cancel_at }}



Survey


Variáveis relacionadas a pesquisas de satisfação.


Variável

Tipo

Descrição Completa

Exemplo

survery.url

URL

Link para o cliente acessar e responder a pesquisa de satisfação. Nota: variável com typo intencional (survery ao invés de survey) para manter compatibilidade.

https://survery.url/12345


Exemplo de uso:

📊 *Pesquisa de Satisfação*

Sua opinião é importante! Responda nossa pesquisa:
{{& survery.url }}



Answer


Variáveis relacionadas a respostas de pesquisas NPS e satisfação.


Variável

Tipo

Descrição Completa

Exemplo

answer.answered_at

DateTime

Data e hora em que a resposta foi enviada pelo cliente.

2019-12-08 12:30:00

answer.comment

String

Comentário ou feedback textual fornecido pelo cliente junto com a nota.

Ótimo serviço

answer.custom_answer

String

Resposta personalizada para pergunta aberta da pesquisa de satisfação.

Achei o serviço excelente

answer.score

Number

Nota NPS (Net Promoter Score) de 0 a 10 referente à disposição do cliente em recomendar.

10

answer.service_score

Number

Nota específica dada pelo cliente para avaliar o serviço oferecido.

10

answer.product_score

Number

Nota específica dada pelo cliente para avaliar o produto adquirido.

10

answer.url

URL

Link para visualizar a resposta completa da pesquisa.

https://nps.url/12345


Exemplo de uso:

⭐ *Nova avaliação recebida!*

NPS: {{ answer.score }}/10
Serviço: {{ answer.service_score }}/10
Produto: {{ answer.product_score }}/10

{{# answer.comment }}
Comentário: "{{ answer.comment }}"
{{/ answer.comment }}

Respondido em: {{# datetime_br }}{{ answer.answered_at }}{{/ datetime_br }}



Tracking


Variáveis relacionadas a rastreamento de origem de tráfego e parâmetros UTM.


Variável

Tipo

Descrição Completa

Exemplo

tracking.utm_source

String

Fonte de origem do tráfego (google, facebook, instagram, newsletter, etc). Parâmetro UTM padrão.

facebook

tracking.utm_campaign

String

Nome da campanha de marketing à qual o link está relacionado.

promocao-semana-do-consumidor

tracking.utm_medium

String

Meio/canal pelo qual o link foi divulgado (email, social, cpc, banner, etc).

email

tracking.utm_term

String

Palavra-chave ou termo de pesquisa relacionado ao link (usado principalmente em campanhas pagas).

desconto-tenis

tracking.utm_content

String

Conteúdo específico do anúncio ou link (útil para testes A/B).

banner-header

tracking.utm_id

String

Identificador único da campanha.

123456

tracking.meta_ads_fbid

String

Identificador de cliques do Facebook Ads (Facebook Click ID).

fb.1234.abcd5678

tracking.google_gclid

String

Identificador de cliques do Google Ads (Google Click ID).

CjwKCAjw...

tracking.google_gclsrc

String

Fonte do Google Click ID. Geralmente "aw.ds" para Google Ads.

aw.ds

tracking.google_dclid

String

Identificador de cliques do Google DoubleClick.

D123456...

tracking.google_gbraid

String

Identificador do Google AdWords para rastreamento de conversões iOS.

E123456...

tracking.google_wbraid

String

Identificador do Google AdWords para rastreamento de conversões web-to-app.

F123456...

tracking.tiktok_ttlid

String

Identificador de cliques de anúncios do TikTok.

TikTokAd1234

tracking.src

String

Checkout de origem da conversão. Parâmetro customizado de algumas plataformas.

checkout-cart

tracking.sck

String

Campanha relacionada ao checkout (diferente de utm_campaign). Parâmetro customizado.

campanha-black-friday

tracking.ip

String

Endereço IP de origem do clique ou conversão.

192.168.0.1


Exemplo de uso:

📊 *Origem do pedido:*

{{# tracking.utm_source }}
Fonte: {{ tracking.utm_source }}
{{/ tracking.utm_source }}

{{# tracking.utm_campaign }}
Campanha: {{ tracking.utm_campaign }}
{{/ tracking.utm_campaign }}

{{# tracking.utm_medium }}
Meio: {{ tracking.utm_medium }}
{{/ tracking.utm_medium }}



Boas Práticas


1. Sempre use condicionais para variáveis opcionais


Nem todas as variáveis estarão disponíveis em todos os eventos. Use seções condicionais:


{{# pix.bacen_code }}
Código PIX: {{ pix.bacen_code }}
{{/ pix.bacen_code }}


2. Use o operador & para URLs


URLs devem usar o operador & para evitar escape HTML:


✅ Correto: {{& order.checkout_url }}
❌ Errado: {{ order.checkout_url }}


3. Aplique helpers de formatação


Use os helpers customizados para melhor apresentação:


{{# currency_br }}{{ pricing.total }}{{/ currency_br }}
{{# date_br }}{{ order.created_at }}{{/ date_br }}
{{# phone_national }}{{ customer.phone }}{{/ phone_national }}


4. Use operador OR para valores padrão


Evite mensagens vazias usando fallback:


{{ customer.first_name || customer.full_name || "Cliente" }}


5. Itere arrays corretamente


Para products e questions_and_answers, use seções:


{{# products }}
- {{ name }}: {{ quantity }}x
{{/ products }}


6. Valide dados sensíveis


Cuidado com dados sensíveis como senhas e códigos de acesso:


Senha temporária: {{ access.password }}
⚠️ Altere sua senha após o primeiro acesso.


7. Formate mensagens de forma clara


Use emojis e formatação Markdown do WhatsApp:


*Negrito* para destaque
_Itálico_ para ênfase
```para código


8. Teste com dados reais


Sempre teste templates com os exemplos em lang/variables-example.json.


9. Mantenha mensagens concisas


WhatsApp funciona melhor com mensagens objetivas. Evite textos muito longos.


10. Use randomização com moderação


O sistema de randomização [[opção1 || opção2]] é útil, mas não abuse para manter consistência.



Referências




Última atualização: 2025-10-22


Atualizado em: 22/10/2025

Este artigo foi útil?

Compartilhe seu feedback

Cancelar

Obrigado!