Tanto a automação de Envio de Email quanto de Webhook podem utilizar variáveis que correspondem aos dados relacionados ao gatilho utilizado.
Por exemplo, em uma automação que utiliza gatilhos de pagamento, como Pagamento Confirmado, é possível usar variáveis relacionados à compra e ao comprador(a), tando no conteúdo do email quanto no payload da requisição via webhook.
Como utilizar uma variável
No corpo do email, ou no body da requisição, basta utilizar a variável entre colchetes, como por exemplo:
{{buyer_email}}
No caso acima, a variável será substituída pelo email do comprador.
Veja a relação de variáveis que podem ser utilizadas:
Variáveis dos Gatilhos de Venda
São as variáveis disponíveis nos gatilhos relacionados à venda: Boleto Vencido, Pix Vencido, Cartão de Crédito Recusado, Assinatura cancelada pelo cliente, Assinatura cancelada pelo produtor, Pagamento Confirmado, Pagamento via Order Bump Confirmado, Boleto Gerado, Pix Criado, Estorno através da operadora (Chargeback), Estorno feito pelo Produtor.
| {{buyer_email}} | Email do comprador |
| {{buyer_name}} | Nome do comprador |
| {{buyer_phone}} | Telefone do comprador |
| {{buyer_phone_raw}} | Telefone do comprador (sem formatação) |
| {{buyer_document_id}} | CPF do comprador |
| {{buyer_document_type}} | Tipo de documento do comprador (sempre CPF) |
| {{buyer_city}} | Endereço: Cidade do comprador |
| {{buyer_complement}} | Endereço: Complemento |
| {{buyer_district}} | Endereço: Bairro |
| {{buyer_address_number}} | Endereço: Número |
| {{buyer_state}} | Endereço: Estado |
| {{buyer_address_street}} | Endereço: CEP |
| {{offer_price }} | O valor da oferta em centavos. Caso seja R$150,00, virá como 15000 |
| {{offer_price | money}} | O valor da oferta em reais. Caso seja R$150,00, virá como R$ 150,00. |
| {{ offer_price | divided_by: 100.00}} | O valor da oferta em reais sem R$. Caso seja R$ 150,00, virá 150.0 |
| {{offer_discount_value}} | O valor do desconto aplicado na oferta (caso seja utilizado um cupom) |
| {{offer_with_discount}} | O valor da oferta com o desconto aplicado (caso seja utilizado um cupom) |
| {{offer_kind}} | O tipo da oferta - "common" (comum); "subscription" (assinatura) |
| {{offer_title}} | O nome da oferta |
| {{offer_id}} | ID da Oferta |
| {{product_id}} | O ID do produto |
| {{product_name}} | O nome do produto |
| {{payment_id}} | O ID da transação |
| {{payment_method}} | O método de pagamento - "credit_card" (cartão de crédito); "pix" (pix); "bank_slip" (boleto) |
| {{payment_status}} | O status do pagamento - "paid" (pago); "refused" (recusado); "error" (erro); "refunded" (estornado); "chargeback" (chargeback); "overdue" (expirado) |
| {{payment_date}} | A data da transação |
| {{payment_value}} | Valor pago pelo comprador em centavos. |
| {{payment_value | divided_by: 100.00}} | Valor pago pelo comprador em reais. |
| {{installments}} | Número de parcelas |
| {{installments_fees}} | Valor da taxa de juros do parcelamento em centavos |
| {{net_value_cents}} | Valor líquido da venda em centavos |
| {{subscription_id}} |
ID da assinatura do comprador (apenas para pagamentos relativos à assinaturas) |
| {{subscription_type}} |
Tipo de recorrência: recurrency (assinatura) / installment (parcelamento de boleto ou pix) / smart_installment (parcelamento inteligente) |
| {{subscription_next_invoice_at}} |
Data da próxima fatura da recorrência |
| {{subscription_expiration_at}} |
Data de encerramento da recorrência |
| {{upsell}} |
Indica se a venda é um upsell (true/false). |
| {{cart_src}} |
SRC |
Variáveis específicas dos gatilhos de venda
PIX
| {{pix_expiration_at}} | Data de expiração do PIX |
| {{pix_code}} | Código do PIX Copia e Cola |
| {{pix_qr_code_url}} | URL com a imagem do QR Code |
Boleto
| {{boleto_expiration_at}} | Data de vencimento do Boleto |
| {{bank_slip_barcode}} | Código de barras do boleto |
| {{bank_slip_file_url}} | URL do boleto |
Cartão de crédito recusado
| {{credit_card_refused_message}} | Motivo da recusa do cartão de crédito |
Assinatura cancelada
| {{subscription_canceled_by}} | Quem cancelou assinatura (produtor ou aluno) |
| {{subscription_status}} | Status da assinatura - "paid" (paga); "overdue" (em atraso); "refused" (pagamento recusado); "canceled" (cancelada) |
|
{{subscription_available_until}} |
Data de término do ciclo atual da assinatura |
Variáveis dos Gatilhos de Engajamento
São as variáveis disponíveis nos gatilhos relacionados ao engajamento: Progresso em 25%, Progresso em 50%, Progresso em 75%, Progresso em 100%, Certificado emitido.
| {{user.email}} | Email do aluno |
| {{ user | fullname | remove_quotation_marks }} | Nome do aluno |
| {{school.id}} | ID da Plataforma |
| {{school.name}} | Nome da Plataforma |
| {{school.url}} | URL da plataforma |
| {{enrollment.id}} | ID da matrícula |
| {{school_product.id}} | ID do produto |
| {{ school_product.title | remove_quotation_marks }} | Nome do produto |
Variáveis específicas dos gatilhos de engajamento
Emissão de certificado
| {{certificate.created_at}} | Data de emissão do certificado |