Variáveis Disponíveis - Gatilhos de Pagamento e Engajamento

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.

Neste artigo você encontra as variáveis dos gatilhos de Pagamento e Engajamento, caso esteja utilizando gatilhos de Recorrência, você deve acessar o artigo de variáveis de recorrência.

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.

Variáveis específicas dos gatilhos de venda

PIX

Boleto

Cartão de crédito recusado

Assinatura cancelada

Você pode utilizar o JSON de exemplo abaixo, que contém todas as variáveis de pagamento existentes. Algumas delas terão valor nulo caso não tenham referência (ex.: código do PIX em um pagamento de cartão de crédito). Lembre-se que você pode editar livremente o JSON de acordo com sua necessidade.

{
"upsell": "{{upsell}}",
"cart_src": "{{cart_src}}",
"utm_id": "{{utm_id}}",
"utm_source": "{{utm_source}}",
"utm_medium": "{{utm_medium}}",
"utm_term": "{{utm_term}}",
"utm_content": "{{utm_content}}",
"utm_campaign": "{{utm_campaign}}",
"offer_id": "{{offer_id}}",
"pix_code": "{{pix_code}}",
"buyer_city": "{{buyer_city}}",
"buyer_name": "{{buyer_name}}",
"offer_kind": "{{offer_kind}}",
"payment_id": "{{payment_id}}",
"product_id": "{{product_id}}",
"buyer_email": "{{buyer_email}}",
"buyer_phone": "{{buyer_phone}}",
"buyer_state": "{{buyer_state}}",
"offer_price": "{{offer_price }}",
"offer_title": "{{offer_title}}",
"installments": "{{installments}}",
"payment_date": "{{payment_date}}",
"created_at": "{{created_at}}",
"product_name": "{{product_name}}",
"payment_value": "{{payment_value}}",
"buyer_district": "{{buyer_district}}",
"payment_method": "{{payment_method}}",
"payment_status": "{{payment_status}}",
"buyer_phone_raw": "{{buyer_phone_raw}}",
"net_value_cents": "{{net_value_cents}}",
"pix_qr_code_url": "{{pix_qr_code_url}}",
"subscription_id": "{{subscription_id}}",
"buyer_complement": "{{buyer_complement}}",
"bank_slip_barcode": "{{bank_slip_barcode}}",
"buyer_document_id": "{{buyer_document_id}}",
"installments_fees": "{{installments_fees}}",
"offer_price_money": "{{offer_price | money}}",
"pix_expiration_at": "{{pix_expiration_at}}",
"subscription_type": "{{subscription_type}}",
"bank_slip_file_url": "{{bank_slip_file_url}}",
"buyer_document_type": "{{buyer_document_type}}",
"offer_price_divided": "{{offer_price | divided_by: 100.00}}",
"offer_with_discount": "{{offer_with_discount}}",
"boleto_expiration_at": "{{boleto_expiration_at}}",
"buyer_address_number": "{{buyer_address_number}}",
"buyer_address_street": "{{buyer_address_street}}",
"buyer_zip_code": "{{buyer_zip_code}}",
"offer_discount_value": "{{offer_discount_value}}",
"payment_value_divided": "{{payment_value | divided_by: 100.00}}",
"subscription_expiration_at": "{{subscription_expiration_at}}",
"credit_card_refused_message": "{{credit_card_refused_message}}",
"offer_with_discount_divided": "{{offer_with_discount | divided_by: 100.00}}",
"subscription_next_invoice_at": "{{subscription_next_invoice_at}}",
"subscription_canceled_by": "{{subscription_canceled_by}}",
"subscription_status": "{{subscription_status}}",
"subscription_available_until": "{{subscription_available_until}}"
}

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.

Variáveis específicas dos gatilhos de engajamento

Emissão de certificado

Variáveis especiais: now

Você pode usar uma variável especial em qualquer automação para registrar a data de envio do webhook.