Pular para o conteúdo principal
O bloco de Resposta é o passo final no seu fluxo de trabalho que formata e envia uma resposta estruturada às chamadas API. É como a declaração “return” para todo o seu fluxo de trabalho—empacota os resultados e os envia de volta.
API
Os blocos de resposta são blocos terminais - finalizam a execução do fluxo de trabalho e não podem se conectar a outros blocos.

​
Visão geral

O bloco de Resposta permite:
1
Formatar respostas API: Estruturar os resultados do fluxo de trabalho em respostas HTTP adequadas
2
Estabelecer códigos de status: Configurar códigos de status HTTP apropriados de acordo com os resultados do fluxo de trabalho
3
Controlar cabeçalhos: Adicionar cabeçalhos personalizados para respostas API e webhooks
4
Transformar dados: Converter variáveis do fluxo de trabalho em formatos de resposta amigáveis ao cliente

​
Como funciona

O bloco de Resposta finaliza a execução do fluxo de trabalho:
1
Recopilar dados - Reúne variáveis e saídas de blocos anteriores
2
Formatar resposta - Estrutura os dados de acordo com sua configuração
3
Estabelecer detalhes HTTP - Aplica códigos de status e cabeçalhos
4
Enviar resposta - Retorna a resposta formatada ao solicitante da API

​
Quando você precisa de blocos de resposta

  • Endpoints API: Quando seu fluxo de trabalho é chamado via API, os blocos de Resposta formatam os dados de retorno
  • Webhooks: Retornam confirmação ou dados ao sistema que realiza a chamada
  • Testes: Ver resultados formatados ao testar seu fluxo de trabalho

​
Duas formas de construir respostas

​
Modo construtor (recomendado)

Interface visual para construir a estrutura de resposta:
  • Arrastar e soltar campos
  • Referenciar variáveis de fluxo de trabalho facilmente
  • Visualização prévia visual da estrutura de resposta

​
Modo editor (avançado)

Escrever JSON diretamente:
  • Controle total sobre o formato de resposta
  • Suporte para estruturas aninhadas complexas
  • Usar sintaxe <variable.name> para valores dinâmicos

​
Opções de configuração

​
Dados de resposta

Os dados de resposta são o conteúdo principal que será enviado de volta ao solicitante da API. Devem estar formatados como JSON e podem incluir:
  • Valores estáticos
  • Referências dinâmicas a variáveis de fluxo de trabalho usando a sintaxe <variable.name>
  • Objetos e arrays aninhados
  • Qualquer estrutura JSON válida

​
Código de status

Estabelece o código de status HTTP para a resposta. Os códigos de status comuns incluem:
  • Tab Title
  • Tab Title
  • Tab Title
  • 200: OK - Resposta padrão de sucesso
  • 201: Criado - Recurso criado com sucesso
  • 204: Sem conteúdo - Sucesso sem corpo de resposta
O código de status padrão é 200 se não especificado.

​
Cabeçalhos de resposta

Configure cabeçalhos HTTP adicionais para incluir na resposta. Os cabeçalhos são configurados como pares chave-valor:
ChaveValor
Content-Typeapplication/json
Cache-Controlno-cache
X-API-Version1.0

​
Exemplos de casos de uso

​
Resposta do endpoint da API

​
Cenário: Retornar dados estruturados de uma API de busca

  1. O fluxo de trabalho processa a consulta de busca e recupera resultados
  2. O bloco de função formata e pagina os resultados
  3. O bloco de resposta retorna JSON com dados, paginação e metadados
  4. O cliente recebe uma resposta estruturada com status 200

​
Confirmação de webhook

​
Cenário: Confirmar recepção e processamento do webhook

  1. O disparador de webhook recebe dados do sistema externo
  2. O fluxo de trabalho processa os dados recebidos
  3. O bloco de resposta retorna uma confirmação com o status do processamento
  4. O sistema externo recebe a confirmação

​
Tratamento de respostas de erro

​
Cenário: Retornar respostas de erro apropriadas

  1. O bloco de condição detecta falhas de validação ou erros do sistema
  2. O roteador direciona para a rota de tratamento de erros
  3. O bloco de resposta retorna status 400/500 com detalhes do erro
  4. O cliente recebe informações estruturadas do erro

​
Entradas e saídas

  • Configuração
  • Variáveis
  • Resultados
  • Dados de resposta: Estrutura JSON para o corpo da resposta
  • Código de status: Código de status HTTP (padrão: 200)
  • Cabeçalhos: Cabeçalhos HTTP personalizados como pares chave-valor
  • Modo: Modo Construtor ou Editor para construção de respostas

​
Referências de variáveis

Utilize a sintaxe <variable.name> para inserir dinamicamente variáveis do fluxo de trabalho na sua resposta: 
{
  "user": {
    "id": "<variable.userId>",
    "name": "<variable.userName>",
    "email": "<variable.userEmail>"
  },
  "query": "<variable.searchQuery>",
  "results": "<variable.searchResults>",
  "totalFound": "<variable.resultCount>",
  "processingTime": "<variable.executionTime>ms"
}
Os nomes de variáveis diferenciam maiúsculas de minúsculas e devem corresponder exatamente às variáveis disponíveis no seu fluxo de trabalho.

​
Melhores práticas

  • Use códigos de status significativos: Escolha códigos de status HTTP apropriados que reflitam com precisão o resultado do fluxo de trabalho
  • Estruture suas respostas de forma consistente: Mantenha uma estrutura JSON consistente em todos os seus endpoints de API para uma melhor experiência do desenvolvedor
  • Inclua metadados relevantes: Adicione timestamps e informações de versão para ajudar com depuração e monitoramento
  • Lide com erros elegantemente: Utilize lógica condicional no seu fluxo de trabalho para estabelecer respostas de erro apropriadas com mensagens descritivas
  • Valide as referências de variáveis: Certifique-se de que todas as variáveis referenciadas existam e contenham os tipos de dados esperados antes que o bloco de Resposta seja executado