Requisição HTTP e Mapeamento de Resposta

No Flow Builder, o nó de Requisição HTTP permite que o fluxo consulte ou envie dados para APIs externas, sistemas legados, CRMs ou ERPs durante o atendimento.

Ao receber a resposta da API externa, você pode extrair campos específicos do JSON e armazená-los em variáveis para usar em nós subsequentes (como Enviar Mensagem, Condição, Transferência, etc.).

Como configurar

No nó de Requisição HTTP, localize o campo:

"Mapeamento da resposta para variáveis (JSON)"

Escreva um objeto JSON no seguinte formato:

{
  "nome_da_variavel": "caminho.na.resposta"
}

Cada entrada vira automaticamente a variável:

{{ form.http_nome_da_variavel }}

Prefixo Obrigatório http_

O prefixo http_ é inserido automaticamente pelo sistema em todas as variáveis mapeadas. Isso impede que os dados retornados pela API sobrescrevam variáveis já coletadas pelo fluxo de atendimento (como form.cpf, form.nome, etc.).

Como escrever o caminho

Use a notação de ponto ou colchetes para navegar pela estrutura JSON retornada pela API:

Caminho	O que pega
`cliente.plano.nome`	Campo dentro de objetos, em quantos níveis forem
`tecnicos[0]` ou `tecnicos.0`	Item da lista pela posição (o índice começa em `0`)
`tecnicos[-1]`	Último item da lista
`faturas[*].valor`	O campo em todos os itens da lista
`faturas[0].linha.codigo`	Combinações, em qualquer profundidade
`["meta.dados"].versao`	Campo cujo nome contenha ponto ou espaço
`$`	A resposta inteira da API

Exemplo completo

1. Resposta da API externa

Considere que a sua API externa respondeu o seguinte JSON:

{
  "protocolo": "2026-001234",
  "cliente": {
    "nome": "Maria",
    "plano": {
      "nome": "500MB",
      "valor": 99.9
    }
  },
  "tecnicos": [
    "João",
    "Ana"
  ],
  "faturas": [
    {
      "vencimento": "2026-10-10",
      "valor": 99.9,
      "linha": {
        "codigo": "123"
      }
    },
    {
      "vencimento": "2026-11-10",
      "valor": 105.5,
      "linha": {
        "codigo": "456"
      }
    }
  ]
}

2. Mapeamento configurado no nó

No campo Mapeamento da resposta para variáveis (JSON), configure:

{
  "cliente": "cliente.nome",
  "plano": "cliente.plano.nome",
  "valor_plano": "cliente.plano.valor",
  "tecnico": "tecnicos[0]",
  "codigo_boleto": "faturas[-1].linha.codigo",
  "vencimentos": "faturas[*].vencimento"
}

3. Variáveis geradas disponíveis no fluxo

A partir deste momento, o fluxo terá acesso às seguintes variáveis:

Variável	Valor obtido
`{{ form.http_cliente }}`	`Maria`
`{{ form.http_plano }}`	`500MB`
`{{ form.http_valor_plano }}`	`99.9`
`{{ form.http_tecnico }}`	`João`
`{{ form.http_codigo_boleto }}`	`456`
`{{ form.http_vencimentos }}`	`["2026-10-10", "2026-11-10"]`

Usando as variáveis nos nós seguintes

Em qualquer nó conectado na saída de sucesso (por exemplo, um nó Enviar Mensagem), você pode referenciar as variáveis normalmente usando a sintaxe Jinja:

Olá {{ form.http_cliente }}! Seu plano é {{ form.http_plano }} (R$ {{ form.http_valor_plano }}).
O técnico responsável é {{ form.http_tecnico }} e o código do seu boleto é {{ form.http_codigo_boleto }}.

Boas práticas

Tratamento de Saídas: O nó HTTP possui saídas distintas para Sucesso (status HTTP 2xx) e Falha/Erro (status HTTP 4xx, 5xx ou timeout). Conecte sempre uma mensagem ou transição amigável na saída de erro.
Nomes Limpos de Variáveis: Use letras minúsculas e sublinhados (_) nas chaves do mapeamento (ex: codigo_boleto, status_fatura).
Combinação com Outros Recursos: As variáveis {{ form.http_* }} podem ser combinadas com Templates Jinja (filtros como |data_br, quebras de linha {{ quebra_de_linha }} e atrasos {{ delay(n) }}) e com Text Rotation.

Como configurar​

Como escrever o caminho​

Exemplo completo​

1. Resposta da API externa​

2. Mapeamento configurado no nó​

3. Variáveis geradas disponíveis no fluxo​

Usando as variáveis nos nós seguintes​

Boas práticas​