🔤 Variáveis no FlowBuilder

As variáveis permitem guardar informações durante a execução do fluxo e reutilizá-las em outros blocos do atendimento.

Por exemplo, o fluxo pode perguntar o CPF do contato, salvar a resposta em uma variável e utilizar esse CPF para consultar uma API. Depois, o resultado da consulta — como o nome do cliente, o status de uma solicitação ou um link de boleto — também pode ser salvo e enviado em uma mensagem.

A variável funciona como um espaço reservado para um valor. Quando o fluxo chega a um bloco que utiliza essa variável, o sistema substitui o nome pelo valor armazenado.

dica

As variáveis são utilizadas somente depois que recebem um valor. Por isso, conecte os blocos na ordem correta: primeiro solicite ou consulte a informação e depois utilize a variável em uma mensagem, condição ou integração.

📦 Como criar uma variável

Criando uma variável com o bloco Pergunta

O bloco Pergunta pode salvar a resposta enviada pelo contato em uma variável.

1. Adicione um bloco Pergunta ao fluxo.
2. Escreva a mensagem que será enviada ao contato.
3. No campo Salvar resposta em, informe o nome da variável.

Exemplo:

Mensagem: Qual é o seu e-mail?
Salvar resposta em: email_cliente

Quando o contato responder, o conteúdo da resposta ficará armazenado na variável email_cliente e poderá ser utilizado nos próximos blocos do fluxo.

Salvando dados retornados por uma integração

O bloco HTTP Request também permite armazenar informações retornadas por uma API.

Considere que uma API retorne o seguinte resultado:

{
  "cliente": {
    "nome": "Maria Silva",
    "status": "ativo"
  }
}

Você pode salvar os valores da resposta em variáveis, por exemplo:

Caminho na resposta	Nome da variável
cliente.nome	nome_cliente
cliente.status	status_cliente

Depois disso, nome_cliente e status_cliente estarão disponíveis para os blocos seguintes.

Para mais detalhes sobre requisições e variáveis de resposta, consulte a documentação do bloco HTTP Request.

💬 Como utilizar uma variável

O formato da variável depende do bloco em que ela será utilizada:

Onde utilizar	Formato	Exemplo
Mensagem, Menu e Bloco Único	{{variavel}}	Olá, {{nome_cliente}}!
HTTP Request, Condição e 2ª via de cobrança	${variavel}	${cpf_cliente}

aviso

Use exatamente o formato indicado para cada bloco. Se forem utilizadas chaves diferentes, o sistema poderá não substituir a variável pelo valor armazenado.

Exemplo em uma mensagem

Se a variável nome_cliente tiver o valor Maria Silva, configure uma mensagem utilizando:

Olá, {{nome_cliente}}! Seu cadastro foi localizado com sucesso.

O contato receberá:

Olá, Maria Silva! Seu cadastro foi localizado com sucesso.

Exemplo em uma requisição HTTP

Se o CPF informado pelo contato foi salvo na variável cpf_cliente, utilize a variável no campo da requisição que deve receber esse dado:

{
  "cpf": "${cpf_cliente}"
}

Durante a execução, ${cpf_cliente} será substituído pelo CPF armazenado.

🔀 Utilizando variáveis em condições

As variáveis também podem ser utilizadas para verificar o resultado de uma etapa e direcionar o contato para caminhos diferentes.

Por exemplo, depois de consultar uma API e salvar o resultado em status_cliente, configure uma condição para verificar se o valor retornado é ativo:

Variável: ${status_cliente}
Condição: é igual a
Valor: ativo

Com isso, o fluxo pode enviar uma mensagem diferente para clientes ativos e inativos.

🏷️ Boas práticas para nomear variáveis

Escolha nomes que indiquem claramente qual informação está armazenada. Isso facilita a configuração e a manutenção do fluxo.

Recomendações:

• use nomes sem espaços;
• prefira letras, números e sublinhado;
• mantenha um padrão de nomenclatura em todo o fluxo;
• escolha nomes específicos, como cpf_cliente, nome_cliente e status_pedido;
• evite nomes genéricos, como valor1, dado ou resposta.

aviso

O nome da variável precisa ser utilizado exatamente como foi criado. Diferenças de maiúsculas, minúsculas, acentos ou caracteres fazem com que o sistema não encontre o valor armazenado.

🧪 Exemplo de fluxo completo

Um fluxo simples para consultar o cadastro de um cliente pode seguir esta sequência:

1. O bloco Pergunta solicita o CPF e salva a resposta em cpf_cliente.
2. O bloco HTTP Request envia ${cpf_cliente} para a API.
3. A resposta da API salva o nome do cliente em nome_cliente.
4. Uma Condição verifica o valor de status_cliente.
5. O bloco Mensagem envia Olá, {{nome_cliente}}! para o contato.

A ordem é importante: cada variável deve ser criada ou preenchida antes de ser utilizada por outro bloco.

🛠️ Problemas comuns

A variável aparece vazia

Verifique se o bloco que preenche a variável foi executado antes do bloco que tenta utilizá-la. Também confirme se o nome foi digitado exatamente igual ao original.

O nome da variável aparece na mensagem

Confirme se o formato corresponde ao bloco utilizado. Em mensagens, menus e blocos únicos, use {{variavel}}. Em requisições HTTP, condições e 2ª via de cobrança, use ${variavel}.

A integração não recebe o valor esperado

Revise o campo da requisição em que a variável foi inserida e confirme se ela possui um valor. No caso de dados retornados por uma API, confira também se o caminho da resposta está correto.

📌 Variáveis fixas

Além das variáveis criadas no fluxo, o sistema disponibiliza variáveis fixas, como {{firstName}} e {{protocol}}.

As variáveis fixas já estão disponíveis e não precisam ser criadas no FlowBuilder.