# JSON

O módulo **JSON** é utilizado para enviar uma resposta do tipo JSON.

## JSON

Com o módulo **JSON** você monta respostas estruturadas dentro do fluxo, definindo código de status, cabeçalhos e corpo da mensagem em um único lugar.

<figure><img src="/files/skXTv4JtRaMZPsgj5ckM" alt=""><figcaption><p>Utilização do módulo <strong>JSON</strong> em um fluxo real</p></figcaption></figure>

### Detalhes do módulo

Para configurar o módulo, preencha os campos abaixo:

* **Nome do módulo**: nome interno para identificar a função do bloco no fluxo.
* **Código de status**: define o resultado da resposta (ex.: `200` para sucesso, `400` para erro de validação).
* **Headers**: pares de chave e valor com metadados da resposta.
* **Body**: conteúdo principal retornado para a próxima etapa.

{% hint style="warning" %}
Antes de usar o módulo **JSON**, você precisa ter um fluxo criado e aberto em **Aplicativo > Fluxos**.
{% endhint %}

**📷 Inserir print:** janela de configuração do módulo JSON com campos preenchidos

### Ações principais

1️⃣ **Adicionar o módulo no diagrama**

**🎯 Propósito**\
Inserir o módulo JSON no ponto correto do fluxo.

**✅ Como fazer na tela**

1. Em **Aplicativo > Fluxos**, abra o fluxo desejado.
2. Na barra de módulos, procure por **JSON**.
3. Arraste e solte o módulo no diagrama.

**📌 Resultado esperado**\
O cartão do módulo JSON aparece no fluxo, pronto para configuração.

**📷 Inserir print:** ação de arrastar e soltar o módulo JSON no fluxo

2️⃣ **Configurar resposta de sucesso**

**🎯 Propósito**\
Retornar dados organizados quando o processo concluir corretamente.

**✅ Como fazer na tela**

1. Abra o módulo JSON.
2. Defina **Código de status** como `200`.
3. Preencha **Headers** e **Body** conforme sua regra.
4. Clique em **Salvar alterações**.

**📌 Resultado esperado**\
O fluxo passa a responder com o padrão de sucesso configurado.

3️⃣ **Configurar resposta de erro controlado**

**🎯 Propósito**\
Padronizar o retorno quando houver falha esperada no fluxo.

**✅ Como fazer na tela**

1. Abra o módulo JSON no caminho de erro.
2. Defina **Código de status** (ex.: `400` ou `422`).
3. No **Body**, informe a mensagem de orientação para o próximo passo.
4. Clique em **Salvar alterações**.

**📌 Resultado esperado**\
Quando o caminho de erro for executado, o retorno segue o padrão definido.

**📷 Inserir print:** exemplos de configuração de sucesso e erro no módulo JSON

### Caso de uso

Imagine um fluxo de qualificação de lead com validação de dados:

1. O cliente preenche informações no atendimento.
2. O fluxo valida os dados recebidos.
3. Em caso de sucesso, o módulo JSON retorna `200` com mensagem de confirmação.
4. Em caso de erro, outro módulo JSON retorna `400` com orientação de correção.

Assim, o fluxo fica previsível e fácil de manter, com resposta padronizada em todos os cenários.

**📷 Inserir print:** fluxo com dois módulos JSON, um para sucesso e outro para erro

### Dicas úteis

* Use nomes objetivos como **JSON - Sucesso** e **JSON - Erro**.
* Mantenha padrão de estrutura entre diferentes respostas do mesmo fluxo.
* Revise status e body antes de salvar para evitar retorno incompleto.
* Conecte corretamente cada módulo JSON ao caminho correspondente do diagrama.

### Resumo

* O módulo **JSON** centraliza a montagem de respostas no fluxo.
* Você configura **Código de status**, **Headers** e **Body** em uma única tela.
* O recurso ajuda a padronizar cenários de sucesso e erro.
* A seção de retorno bem definida deixa o fluxo mais claro para operação e manutenção.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/resposta/json.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.