--- title: Documentação Técnica description: Documentação técnica --- [Pular para o conteúdo](https://help-flow.iasbeck.co/pt/documentacao-tecnica#main-content) Português Mostrar submenu para traduções [![Flow\_Logo-1](https://help-flow.iasbeck.co/hs-fs/hubfs/Flow_Logo-1.png?width=451&height=150&name=Flow_Logo-1.png)](https://help-flow.iasbeck.co/pt?hsLang=pt) Abrir navegação principal Fechar navegação principal - Português Mostrar submenu para traduções Como podemos ajudá-lo? - Não há sugestões porque o campo de pesquisa está em branco. 1. [Flow - Iasbeck](https://help-flow.iasbeck.co/pt?hsLang=pt) 2. [Documentação](https://help-flow.iasbeck.co/pt/documenta%C3%A7%C3%A3o?hsLang=pt) # Documentação Técnica ## O Flow é uma plataforma de orquestração de workflows baseada em eventos e agendamentos. Sua arquitetura permite a composição visual de fluxos de integração entre sistemas heterogêneos, com suporte a lógica condicional, transformação de dados e execução assíncrona em alta escala. Esta documentação é destinada a desenvolvedores, arquitetos de integração e times técnicos responsáveis pela implementação e manutenção de workflows no Flow. #### **Estrutura de um Workflow** Cada workflow no Flow é composto por uma sequência de **nós** encadeados, onde a saída de um nó alimenta a entrada do próximo. O fluxo de execução é definido visualmente no editor e armazenado como uma estrutura de grafo direcionado. Um workflow possui obrigatoriamente: - Um **nó de gatilho** (trigger) como ponto de entrada - Um ou mais **nós de processamento** (apps, lógica, transformação) - Opcionalmente, **nós de controle de fluxo** (IF/ELSE, Switch Case) --- #### **Gatilhos (Triggers)** ### **Receive Webhook** Expõe um endpoint HTTP único por workflow. O Flow aguarda requisições POST com payload em JSON. O corpo da requisição é disponibilizado automaticamente para os nós seguintes. **Configuração:** O endpoint é gerado automaticamente ao adicionar o nó. Suporta headers customizados e validação de payload. **Exemplo de payload de entrada:** `{` `  "evento": "novo_contato",` `  "dados": {` `    "nome": "Carlos Mendes",` `    "email": "carlos@empresa.com",` `    "origem": "formulario_site"` `  }` `}` ### **Manual Trigger** Inicia o workflow por ação direta do usuário no painel. Usado para execuções pontuais, homologações e testes de fluxo em ambiente de produção. ### **Schedule Trigger** Executa o workflow em intervalos configurados: horário, diário, semanal, mensal ou expressão customizada. Ideal para rotinas de ETL, relatórios automáticos e sincronizações periódicas. --- #### **Nós de Lógica** ### **IF / ELSE** Desvia o fluxo com base em uma condição booleana avaliada em tempo de execução. Suporta operadores de comparação (igual, diferente, maior que, menor que, contém, começa com) e operadores lógicos (E, OU). **Uso típico:** Validar se um campo existe, comparar valores numéricos, verificar o conteúdo de um status. ### **Switch Case** Avalia um valor de entrada contra múltiplos casos definidos (Case 1, Case 2, Case 3... até N casos) e um caminho padrão (Default). Cada caso encaminha o fluxo para uma ramificação independente. **Uso típico:** Rotear processos por tipo de cliente, status de pedido, categoria de produto ou qualquer valor discreto. --- #### **Apps e Autenticação** Os **Apps** são conectores configurados pelo usuário que representam a autenticação com um sistema externo. Uma vez criado, um App fica disponível para uso em qualquer workflow da organização. ### **Métodos de Autenticação Suportados** **OAuth2** — Fluxo padrão de autorização delegada. O usuário autoriza o acesso via redirecionamento e o Flow armazena o token de acesso e refresh token de forma segura. Renovação automática do token antes da expiração. *Exemplo de apps com OAuth2:* HubSpot, Google Sheets, Google Calendar, Salesforce. **API Key** — A chave é inserida manualmente e enviada nos headers ou query parameters das requisições, conforme a especificação do sistema de destino. *Exemplo de apps com API Key:* ClickUp, GitHub, sistemas internos com API REST customizada. **Basic Auth** — Credenciais de usuário e senha codificadas em Base64 e enviadas via header Authorization. Compatível com sistemas legados e APIs de mensageria. *Exemplo de apps com Basic Auth:* Twilio, sistemas ERP com autenticação básica. --- #### **Ações de App** Cada App conectado expõe um conjunto de **ações** que o usuário pode utilizar como nós dentro de um workflow. As ações encapsulam chamadas de API pré-configuradas, eliminando a necessidade de montar requisições HTTP manualmente. **Exemplo — HubSpot (OAuth2 · 4 ações disponíveis):** - Criar contato - Atualizar propriedades de contato - Buscar contato por e-mail - Criar negócio (Deal) **Exemplo — ClickUp (API Key · 2 ações disponíveis):** - Criar tarefa - Atualizar tarefa existente **Exemplo — Twilio (Basic Auth · 1 ação disponível):** - Enviar mensagem SMS / WhatsApp --- #### **Mapeamento e Transformação de Dados** Os dados trafegam entre nós por meio de um sistema de referência de variáveis. Cada nó disponibiliza sua saída como um objeto acessível pelos nós seguintes. **Notação de referência:** `｛{nome_do_no.campo}｝` **Exemplo:** Se o gatilho Webhook recebeu um payload com dados.email, esse valor pode ser referenciado em qualquer nó posterior como: `｛{trigger.dados.email} ` O Flow suporta transformações inline, como concatenação de strings, formatação de datas e operações aritméticas simples, diretamente no campo de mapeamento. --- #### **Painel de Execuções** Cada execução de workflow gera um registro com os seguintes campos: | **Campo** | **Descrição** | | --- | --- | | **Workflow** | Nome do workflow executado | | **ID** | Identificador único da execução (UUID) | | **Status** | Concluída / Com erro / Em andamento | | **Gatilho** | Tipo de trigger que iniciou a execução | | **Iniciado em** | Data e hora de início (fuso configurado na conta) | | **Duração** | Tempo total de execução em segundos | O painel suporta paginação (exibe 10 registros por página) e filtragem por workflow. É possível navegar pelo histórico completo de execuções — por exemplo, uma conta com 399 execuções terá 40 páginas de histórico disponíveis para auditoria. --- #### **API REST do Flow** O Flow disponibiliza uma API para automação de operações de gerenciamento: GET    /workflows              → Lista todos os workflows da organização POST   /workflows/{id}/trigger → Dispara manualmente um workflow GET    /executions             → Lista histórico de execuções GET    /executions/{id}        → Detalhes de uma execução específica **Autenticação:** Bearer Token gerado na seção de Conta do painel. --- #### **Segurança** - Compatível com **SOC 2** - Todas as comunicações utilizam **TLS/HTTPS** - Credenciais de apps armazenadas com **criptografia de ponta a ponta** - Tokens de autenticação nunca expostos nos logs de execução - Controle de acesso por organização: apenas o owner pode ativar planos e gerenciar integrações críticas --- **Precisa de suporte técnico especializado?** [Entre em contato com nosso time](https://help-flow.iasbeck.co/pt/documentacao-tecnica#abrir-chat) ### **Glossário Técnico** #### **Termos e conceitos do Flow** Um glossário de referência rápida para usuários, analistas e desenvolvedores que trabalham com o Flow no dia a dia. --- **Workflow** Um fluxo de automação composto por uma sequência de nós conectados. Representa um processo completo — do evento que o inicia até as ações que executa em sistemas externos. No Flow, workflows são criados visualmente e podem ser publicados, desativados ou executados manualmente. **Nó (Node)** Cada bloco individual dentro de um workflow. Um nó pode ser um gatilho, um operador de lógica ou uma ação em um app externo. Os nós se conectam em sequência, e a saída de um alimenta a entrada do próximo. **Gatilho (Trigger)** O nó de entrada de todo workflow. Define o evento que coloca o fluxo em execução. O Flow oferece três tipos: Receive Webhook (evento externo via HTTP), Schedule Trigger (agendamento por tempo) e Manual Trigger (acionamento humano pelo painel). **Webhook** Um mecanismo de comunicação em que um sistema envia uma requisição HTTP automaticamente quando um evento ocorre. No Flow, o Receive Webhook gera um endpoint único que aguarda essas requisições e as usa como ponto de partida para o workflow. **Payload** O corpo de dados enviado junto com uma requisição HTTP. No contexto do Flow, é o conjunto de informações que o gatilho recebe e disponibiliza para os nós seguintes. Exemplo: os dados de um contato sincronizado pelo HubSpot (appId, eventId, objectId, portalId, changeSource). **App** Uma conexão autenticada com um sistema externo, configurada na seção Apps do painel. Cada App armazena as credenciais de acesso (OAuth2, API Key ou Basic Auth) e expõe as ações disponíveis para uso nos workflows. **Ação** Uma operação específica que o Flow pode executar em um sistema externo por meio de um App conectado. Exemplos: "Criar contato no HubSpot", "Criar tarefa no ClickUp", "Enviar SMS pelo Twilio". **OAuth2** Protocolo de autorização que permite ao Flow acessar sistemas externos sem armazenar senhas. O usuário autoriza o acesso via redirecionamento, e o sistema emite um token que o Flow utiliza nas requisições. O token é renovado automaticamente. **API Key** Chave de acesso gerada pela plataforma de destino e fornecida ao Flow para autenticação. Mais simples que OAuth2, requer que o usuário gere e armazene a chave no App. **Basic Auth** Método de autenticação por usuário e senha, codificados em Base64 e enviados no cabeçalho das requisições. Compatível com sistemas legados e APIs mais simples. - [FAQs](https://help-flow.iasbeck.co/pt/faqs?hsLang=pt) - [Comece aqui](https://help-flow.iasbeck.co/pt/comece-aqui?hsLang=pt) - [Suporte](https://help-flow.iasbeck.co/pt/suporte?hsLang=pt) - [Documentação](https://help-flow.iasbeck.co/pt/documenta%C3%A7%C3%A3o?hsLang=pt) [![Flow\_Logo-2](https://help-flow.iasbeck.co/hs-fs/hubfs/Flow_Logo-2.png?width=301&height=100&name=Flow_Logo-2.png "Flow_Logo-2")](https://iasbeck.co/meetings/gabriel-zingo?hsLang=pt) Copyright © 2026, Iasbeck&Co