> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/resposta/json.md).

# JSON

O módulo **JSON** é utilizado para enviar uma resposta do tipo 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="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FIxbzQtfw5GjSBbtdxE2l%2Fjson-gif.gif?alt=media&amp;token=931efd87-960b-4685-ac76-5231ed57142c" 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 %}

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FBU6mgstdyQBjD1uxDdUS%2F02-janela-configuracao-preenchida.png?alt=media&amp;token=daa48950-98d0-4555-a8d1-d02eda5a0f20" alt=""><figcaption><p>Imagem 1 - Janela de configuração do módulo JSON com campos preenchidos.</p></figcaption></figure>

### 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.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FkWHZplaRZRdBTxQo77Lk%2F03-arrastar-soltar-modulo.png?alt=media&amp;token=1f8b5028-5818-4d2f-8e88-18bab69b5732" alt=""><figcaption><p>Imagem 2 - Módulo JSON arrastado para o diagrama, pronto para configuração.</p></figcaption></figure>

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.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2Fvhiq4xYTyU2tmSiJ0t2f%2F04-exemplos-sucesso-erro.png?alt=media&amp;token=1e15ade2-fd14-40da-bf00-97f46f85ba68" alt=""><figcaption><p>Imagem 3 - Exemplos de configuração: resposta de sucesso (200) e resposta de erro (400).</p></figcaption></figure>

### 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.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FOFWhO7MEoQRaEegv2nIT%2F05-fluxo-dois-modulos-json.png?alt=media&amp;token=028de5e3-4197-4770-9b60-6b03b986d847" alt=""><figcaption><p>Imagem 4 - Fluxo com dois módulos JSON conectados ao gatilho, um para sucesso e outro para erro.</p></figcaption></figure>

### 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.