Variáveis Disponíveis - Gatilhos de Recorrência

Os gatilhos de recorrência são todos os gatilhos de Assinatura, Parcelamento inteligente e Parcelamento por boleto e pix. Listados em uma categoria especial no piloto automático chamada "Recorrências".

As variáveis dos gatilhos de recorrência são diferentes das demais categorias, como "Pagamentos" e "Engajamentos" observadas aqui, dessa forma, tanto o payload utilizado na requisição via webhook, como as variáveis utilizadas no conteúdo de email, são diferentes. 

Variáveis do tipo "recurrency"

Variáveis com prefixo "recurrency" são as variáveis que trazem informações a respeito da recorrência adquirida pelo comprador.

Exemplo: é um parcelamento inteligente, assinatura, parcelamento por boleto ou pix? A variável {{recurrencyType}} vai trazer essa informação. 

Variáveis do tipo "Buyer"

Variáveis com prefixo "buyer" são as variáveis que trazem informações a respeito do comprador.

Exemplo: Como vou identificar o meu aluno? As variáveis {{buyerEmail} ou {{buyerStudentUid}} vão te ajudar a conseguir essa informação.

Variáveis do tipo "Offer"

Variáveis com prefixo "offer" são as variáveis que trazem informações a respeito da oferta adquiria pelo comprador.

Exemplo: Como vou identificar a oferta adquira? A variável {{offerTitle}} vai ter ajudar a conseguir essa informação.

Variáveis do tipo "Cart"

Variáveis com prefixo "cart" são as variáveis que trazem informações a respeito do carrinho de compra.

Exemplo: Como posso fornecer o link de acesso do meu comprador por WhatsApp? A variável {{invitationUrl}} vai ter ajudar a conseguir essa informação.

Variáveis do tipo "Product"

Variáveis com prefixo "product" são as variáveis que trazem informações a respeito do produto adquirido pelo comprador.

Exemplo: Como posso identificar o produto adquirido pelo comprador? A variável {{productName}} vai ter ajudar a conseguir essa informação.

Variáveis do tipo "Coupon"

Variáveis com prefixo "Coupon" são as variáveis que trazem informações de cupom quando utilizado pelo comprador. 
Atenção: ofertas de assinatura não possuem cupom, somente unitárias (parcelamento inteligente e parcelamento por boleto e pix são ofertas unitárias)

Exemplo: Como posso identificar a porcentagem de desconto do cupom utilizado pelo comprador? A variável {{couponPercentageValue}} vai ter ajudar a conseguir essa informação.

Variáveis do tipo "Purchase"

Variáveis com prefixo "Purchase" são as variáveis que trazem detalhes a respeito da compra feita pelo comprador. 

Exemplo: Como identificar se minha estratégia de orderbump esta funcionando? A variável {{purchaseBumpUsed}} vai ter ajudar a conseguir essa informação.

Variável "bump"

A variável {{bump}} vai trazer as informações a respeito de todos os produtos orderbump adquiridos pelo comprador na compra. Basta você a variável {{bump}} no body que as seguintes informações serão retornadas:

Atenção: ofertas de assinatura não possuem orderbump, somente unitárias (parcelamento inteligente e parcelamento por boleto e pix são ofertas unitárias)

Variável "allPayments"

A variável {{allPayments}} vai trazer as informações a respeito de todos os pagamentos gerados por essa recorrência. Basta inserir a variável {{allPayments}} no body que as seguintes informações serão retornadas: 

Além de todas as variáveis citadas, temos as variáveis que enviam a data de envio do webhook e identificador da plataforma

Payload com todas as variáveis

Ao criar uma automação do tipo webhook com os gatilhos de recorrência, um payload exemplo com todas as variáveis já vem preenchido. Podendo customizar com as variáveis que deseja manter ou não na requisição.

Ao utilizar o payload com todas as variáveis, 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 de acordo com sua necessidade. 

{ 
"execution_at": "{{executionAt}}",
"platform_uid": "{{platformUid}}",
"recurrency": {
"id": "{{recurrencyId}}",
"status": "{{recurrencyStatus}}",
"canceled_by": "{{recurrencyCanceledBy}}",
"amount": "{{recurrencyAmount}}",
"period": "{{recurrencyPeriod}}",
"next_invoice_at": "{{recurrencyNextInvoiceAt}}",
"created_at": "{{recurrencyCreatedAt}}",
"total_collected": "{{recurrencyTotalCollected}}",
"expiration_at": "{{recurrencyExpirationAt}}",
"expired": "{{recurrencyExpired}}",
"max_cycles": "{{recurrencyMaxCycles}}",
"cycle_restriction": "{{recurrencyCycleRestriction}}",
"paid_installments": "{{recurrencyPaidInstallments}}",
"allow_overdue_access": "{{recurrencyAllowOverdueAccess}}",
"type": "{{recurrencyType}}",
"cancellation_reason": "{{recurrencyCancellationReason}}",
"canceled_at": "{{recurrencyCanceledAt}}"
"overdue_count":"{{recurrencyOverdueCount}}"
},
"purchase": {
"id": "{{purchaseId}}",
"bump_used": "{{purchaseBumpUsed}}",
"is_upsell": "{{purchaseIsUpsell}}"
},
"buyer": {
"id": "{{buyerId}}",
"email": "{{buyerEmail}}",
"student_uid": "{{buyerStudentUid}}",
"address_number": "{{buyerAddressNumber}}",
"street_address": "{{buyerStreetAddress}}",
"city": "{{buyerCity}}",
"complement": "{{buyerComplement}}",
"ddi": "{{buyerDDI}}",
"district": "{{buyerDistrict}}",
"document_type": "{{buyerDocumentType}}",
"full_name": "{{buyerFullName}}",
"phone": "{{buyerPhone}}",
"phone_raw": "{{buyerPhoneRaw}}",
"state": "{{buyerState}}",
"zip_code": "{{buyerZipCode}}",
"created_at": "{{buyerCreatedAt}}",
"document_number": "{{buyerDocumentNumber}}"
},
"offer": {
"id": "{{offerId}}",
"title": "{{offerTitle}}",
"payment_methods": "{{offerPaymentMethods}}",
"price": "{{offerPrice}}",
"period": "{{offerPeriod}}"
"offer_discount": "{{offerWithDiscount}}"
},
"cart": {
"id": "{{cartId}}",
"src": "{{cartSrc}}",
"multicard": "{{cartMulticard}}",
"kind": "{{cartKind}}"
"public_id": "{{cartPublicId}}"
"invitation_url": "{{invitationUrl}}"
},
"product": {
"id": "{{productId}}",
"name": "{{productName}}",
"product_uid": "{{productUid}}",
"is_principal": "{{productIsPrincipal}}"
},
"coupon": {
"id": "{{couponId}}",
"available_until": "{{couponAvailableUntil}}",
"code": "{{couponCode}}",
"consumed": "{{couponConsumed}}",
"fixed_amount": "{{couponFixedAmount}}",
"percentage_value": "{{couponPercentageValue}}",
"quantity": "{{couponQuantity}}",
"created_at": "{{couponCreatedAt}}",
"product_id": "{{couponProductId}}"
},
"bumps": "{{bumps}}",
"payments": "{{allPayments}}"
}

Exemplo de payload recebido

{
    "execution_at": "2023-06-20T14:28:32Z",
    "platform_uid": "123",
    "recurrency": {
        "id": 1,
        "status": "active",
        "canceled_by": null,
        "amount": 5000.00,
        "period": "monthly",
        "next_invoice_at": "2023-07-20T00:00:00Z",
        "created_at": "2022-06-20T00:00:00Z",
        "total_collected": 60000.00,
        "expiration_at": "2024-06-20T00:00:00Z",
        "expired": false,
        "max_cycles": 24,
        "cycle_restriction": "limited",
        "paid_installments": 12,
        "allow_overdue_access": true,
        "type": "recurrency",
        "cancellation_reason": null,
        "canceled_at": null
    },
    "purchase": {
        "id": 1,
        "bump_used": false,
        "is_upsell": true
    },
    "buyer": {
        "id": 1,
        "email": "buyer@example.com",
        "student_uid": "1",
        "address_number": "123",
        "street_address": "Main Street",
        "city": "Example City",
        "complement": "Apt 4",
        "ddi": "+55",
        "district": "Central",
        "document_type": "CPF",
        "full_name": "John Doe",
        "phone": "(11) 9 9999-9999",
        "phone_raw": "1199999999",
        "state": "SP",
        "zip_code": "01000-000",
        "created_at": "2022-01-01T00:00:00Z",
        "document_number": "123.456.789-00"
    },
    "offer": {
        "id": 1,
        "title": "Special Offer",
        "payment_methods": ["credit_card", "bank_slip"],
        "price": 5000.00,
        "period": "monthly"
        "offer_discount": "4500.00",
    },
    "cart": {
        "id": 1,
        "src": "online",
        "multicard": false,
        "kind": "recurrency"
        "public_id": "123456"
        "invitation_url": "https://urldaescola.com/users/invitation/accept?invitation_token=QzrHxdmJSVskBghjogKo"
    },
    "product": {
        "id": 1,
        "title": "Online Course",
        "product_uid": "1",
        "is_principal": true
},
    "coupon": {
        "id": 1,
        "available_until": "2023-12-31T23:59:59Z",
        "code": "DISCOUNT50",
        "consumed": 10,
        "percentage_value": 10.00,
        "quantity": 100,
        "created_at": "2023-01-01T00:00:00Z",
        "product_id": 1
    },
    "payments": {
        "id": 1,
        "buyerId": 1,
        "cartId": 1,
        "couponId": 1,
        "anchorPrice": 5000.00,
        "bankSlipBarcode": "12345678901234567890",
        "bankSlipExpirationDate": "2023-07-20T00:00:00Z",
        "bankSlipFileUrl": "https://example.com/bank_slip.pdf",
        "cardHolderName": "John Doe",
        "paidAt": "2023-06-20T14:28:32Z",
        "totalAmount": 5000.00,
        "totalDue": 0.00,
        "fixedFee": 0.00,
        "installments": 1,
        "installmentsFee": 0.0,
        "status": "paid",
        "totalFees": 4.56,
        "transactionFee": 3.56,
        "dueAt": "2023-06-20T14:28:32Z",
        "errorMessage": null,
        "errorCode": null,
        "pixExpiration": "2023-07-20T00:00:00Z",
        "pixQrCode": "qr_code_data",
        "pixUrl": "https://example.com/pix",
        "createdAt": "2023-06-20T14:28:32Z",
        "updatedAt": "2023-06-20T14:28:32Z",
        "refundRequestedAt": null,
        "purchaseId": "1",
        "nnetValue": 5000.00,
        "method": "credit_card",
        "refundedAt": null

    },
    "bumps": [
        {
            "offerId": 1,
            "offerPrice": 1000.00,
            "offerTitle": "Bump Offer",
            "productUid": "2",
            "productName": "Additional Course",
            "productIsPrincipal": false
        }
}