Response

O bloco Response formata e envia respostas HTTP estruturadas de volta para chamadores de API. Use-o para retornar resultados de workflow com códigos de status e headers apropriados.

Opções de Configuração

Dados da Resposta

Os dados da resposta são o conteúdo principal que será enviado de volta ao chamador da API. Devem ser formatados como JSON e podem incluir:

• Valores estáticos
• Referências dinâmicas a variáveis do workflow usando a sintaxe <variable.name>
• Objetos e arrays aninhados
• Qualquer estrutura JSON válida

Status Code

Defina o código de status HTTP para a resposta (padrão é 200):

Sucesso (2xx):

• 200: OK - Resposta de sucesso padrão
• 201: Criado - Recurso criado com sucesso
• 204: Sem Conteúdo - Sucesso sem corpo de resposta

Erro do Cliente (4xx):

• 400: Requisição Inválida - Parâmetros de requisição inválidos
• 401: Não Autorizado - Autenticação necessária
• 404: Não Encontrado - Recurso não existe
• 422: Entidade Não Processável - Erros de validação

Erro do Servidor (5xx):

• 500: Erro Interno do Servidor - Erro no lado do servidor
• 502: Gateway Inválido - Erro de serviço externo
• 503: Serviço Indisponível - Serviço temporariamente indisponível

Headers de Resposta

Configure headers HTTP adicionais para incluir na resposta.

Headers são configurados como pares chave-valor:

Exemplos de Uso

Resposta de Endpoint de API - Retorna dados estruturados de uma API de busca

Agent (Buscar) → Function (Formatar & Paginar) → Response (200, JSON)

Confirmação de Webhook - Reconhece o recebimento e processamento do webhook

Webhook Trigger → Function (Processar) → Response (200, Confirmação)

Tratamento de Resposta de Erro - Retorna respostas de erro apropriadas

Condition (Erro Detectado) → Router → Response (400/500, Detalhes do Erro)

Outputs

Blocos Response são terminais - eles finalizam a execução do workflow e enviam a resposta HTTP para o chamador da API. Nenhum output está disponível para blocos posteriores.

Referências de Variáveis

Use a sintaxe <variable.name> para inserir dinamicamente variáveis de workflow 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"
}

Boas Práticas

• Use códigos de status significativos: Escolha códigos de status HTTP apropriados que refletem com precisão o resultado do workflow
• Estruture suas respostas consistentemente: Mantenha uma estrutura JSON consistente em todos os seus endpoints de API para melhor experiência do desenvolvedor
• Inclua metadados relevantes: Adicione timestamps e informações de versão para ajudar com debugging e monitoramento
• Trate erros com elegância: Use lógica condicional no seu workflow para definir respostas de erro apropriadas com mensagens descritivas
• Valide referências de variáveis: Garanta que todas as variáveis referenciadas existam e contenham os tipos de dados esperados antes do bloco Response executar