9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
321 lines
12 KiB
Plaintext
321 lines
12 KiB
Plaintext
---
|
|
title: Recursos de Fluxo de Trabalho
|
|
info: Referência completa para todos os gatilhos, ações e recursos de gerenciamento de fluxo de trabalho disponíveis.
|
|
image: /images/user-guide/workflows/robot.png
|
|
sectionInfo: Automatize processos e integre com ferramentas externas
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/workflows/robot.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## Gatilhos de Fluxo de Trabalho
|
|
|
|
Os fluxos de trabalho sempre começam com um único gatilho que define quando a automação deve ser executada.
|
|
|
|
### Registro é Criado
|
|
|
|
Inicia o fluxo de trabalho quando um novo registro é criado em um objeto selecionado (Pessoas, Empresas, Oportunidades ou qualquer objeto personalizado).
|
|
|
|
**Configuração**: Selecione o tipo de objeto para monitorar novos registros.
|
|
|
|
### Registro é Atualizado
|
|
|
|
Inicia o fluxo de trabalho quando mudanças são feitas em um registro existente.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o tipo de objeto
|
|
- Opcionalmente, especifique quais campos monitorar para mudanças
|
|
|
|
### Registro é Atualizado ou Criado
|
|
|
|
Inicia o fluxo de trabalho quando um registro é criado ou atualizado em um objeto selecionado.
|
|
|
|
**Por que Isso é Importante**: Este gatilho é particularmente útil porque registros criados por diferentes métodos se comportam de maneira diferente:
|
|
|
|
- **Importações API/CSV**: Registros são criados com todos os campos preenchidos imediatamente
|
|
- **Criação manual**: Registros são criados primeiro, depois os campos são adicionados em atualizações subsequentes
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o tipo de objeto para monitorar
|
|
- Opcionalmente, especifique quais campos monitorar para mudanças
|
|
- O fluxo de trabalho será acionado tanto na criação inicial quanto em quaisquer atualizações subsequentes
|
|
|
|
### Registro é Excluído
|
|
|
|
Inicia o fluxo de trabalho quando um registro é removido de um objeto.
|
|
|
|
**Configuração**: Selecione o tipo de objeto para monitorar exclusões.
|
|
|
|
### Lançamento Manual
|
|
|
|
Inicia o fluxo de trabalho quando acionado por uma ação do usuário. Este gatilho pode ser acessado através do menu Cmd+K ou por um botão personalizado na barra de navegação superior.
|
|
|
|
**Configuração de Disponibilidade**:
|
|
Escolha como o fluxo de trabalho deve lidar com a seleção de registros:
|
|
|
|
- **Global**: Nenhum registro é necessário para acionar este fluxo de trabalho. O fluxo de trabalho é acionado de qualquer lugar (de qualquer objeto) e não usa registros como entrada.
|
|
|
|
- **Único**: O(s) registro(s) selecionado(s) será(ão) passados para o seu fluxo de trabalho. Esta configuração é para um objeto determinado. Vários registros podem ser selecionados antes de acionar o fluxo de trabalho. O fluxo de trabalho será executado tantas vezes quantos registros forem selecionados.
|
|
|
|
<Warning>
|
|
You cannot run more than 100 workflows in parallel at any given time.
|
|
</Warning>
|
|
|
|
- **Bulk**: O(s) registro(s) selecionado(s) será(ão) passado(s) para o seu fluxo de trabalho. Isso está configurado para um objeto determinado. Vários registros podem ser selecionados antes de acionar o fluxo de trabalho. O fluxo de trabalho será executado uma vez, fornecendo a lista inteira de registros como entrada. Isso significa que o fluxo de trabalho precisa conter uma ação de Iterador. Isso é melhor para pessoas que querem otimizar/limitar o número de execuções do fluxo de trabalho.
|
|
|
|
**Configuração Adicional**:
|
|
|
|
- Selecione o objeto-alvo (para disponibilidade única e em massa)
|
|
- Escolha um ícone de comando para o disparador do fluxo de trabalho
|
|
- Configure a colocação da barra de navegação (Fixada ou Não Fixada)
|
|
|
|
**Métodos de Acesso**:
|
|
|
|
- Menu Cmd+K para encontrar e iniciar fluxos de trabalho manuais
|
|
- Botão personalizado na barra de navegação superior (se configurado)
|
|
|
|
### Agendar
|
|
|
|
Inicia o fluxo de trabalho de forma recorrente conforme você definir.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione a unidade de tempo (minutos, horas, dias)
|
|
- Insira um valor ou utilize expressões cron personalizadas para agendamento avançado
|
|
|
|
### Webhook
|
|
|
|
Inicia o fluxo de trabalho quando uma requisição GET ou POST é recebida de um serviço externo.
|
|
|
|
**Configuração**:
|
|
|
|
- Receba uma URL exclusiva de webhook
|
|
- Para requisições POST, defina a estrutura corporal esperada
|
|
- Configure a autenticação, se necessário
|
|
|
|
## Ações de Fluxo de Trabalho
|
|
|
|
As ações definem o que acontece após um disparo ser acionado. Você pode encadear várias ações juntas.
|
|
|
|
### Criar um Registro
|
|
|
|
Adiciona um novo registro a um objeto selecionado.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o objeto-alvo
|
|
- Preencha os campos obrigatórios e opcionais
|
|
- Use dados de etapas anteriores para preencher campos
|
|
|
|
**Saída**: Os dados do registro recém-criado estão disponíveis para uso nas etapas subsequentes.
|
|
|
|
### Atualizar Registro
|
|
|
|
Modifica um registro existente em um objeto selecionado.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o objeto-alvo
|
|
- Escolha o registro específico para atualizar
|
|
- Selecione campos para modificar e insira novos valores
|
|
|
|
**Saída**: Os dados do registro atualizado estão disponíveis para uso nas etapas subsequentes.
|
|
|
|
### Excluir Registro
|
|
|
|
Remove um registro de um objeto selecionado.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o objeto-alvo
|
|
- Escolha o registro específico para excluir
|
|
|
|
**Saída**: Os dados do registro excluído permanecem disponíveis para uso nas etapas subsequentes.
|
|
|
|
### Pesquisar Registros
|
|
|
|
Encontra registros dentro de um objeto selecionado usando condições de filtro.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o objeto para buscar
|
|
- Defina critérios de filtro para restringir os resultados
|
|
- Configure classificação e limites
|
|
|
|
**Saída**: Retorna registros correspondentes que podem ser usados nas etapas subsequentes.
|
|
|
|
**Melhor Prática**: Use ramificações após Pesquisar Registros para lidar com cenários "encontrado" vs "não encontrado".
|
|
|
|
### Iterador
|
|
|
|
Percorre um array de registros retornado de uma etapa anterior, permitindo realizar ações em cada registro individualmente.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o array de registros de uma etapa anterior (por exemplo, resultados de Pesquisar Registros)
|
|
- Defina as ações a serem realizadas em cada registro no loop
|
|
- Configure o nome da variável para referenciar cada registro na iteração
|
|
|
|
**Exemplo**: Pesquisar Registros retorna 5 pessoas, use o Iterador para enviar um e-mail para cada pessoa ou atualizar cada registro individualmente.
|
|
|
|
**Nota**: Iterador está atualmente em beta. Ative em Configurações > Lançamentos > Lab.
|
|
|
|
### Filtro
|
|
|
|
Filtra um array de registros com base em condições especificadas, permitindo que apenas registros que atendam aos critérios passem adiante.
|
|
|
|
**Configuração**:
|
|
|
|
- Selecione o array de registros para filtrar
|
|
- Defina condições de filtro e critérios
|
|
- Configure quais registros devem passar para as etapas subsequentes
|
|
|
|
**Saída**: Retorna apenas os registros que correspondem às condições de filtro especificadas.
|
|
|
|
### Enviar E-mail
|
|
|
|
Envia um e-mail a partir do seu fluxo de trabalho.
|
|
|
|
**Pré-requisitos**: Adicione uma conta de e-mail em Configurações > Contas
|
|
|
|
**Configuração**:
|
|
|
|
- Insira o endereço de e-mail do destinatário
|
|
- Defina a linha de assunto
|
|
- Compor o corpo da mensagem
|
|
- Referencie variáveis de etapas anteriores para personalização
|
|
|
|
**Nota**: Anexos de e-mail estarão disponíveis no Q1 2026.
|
|
|
|
### Código
|
|
|
|
Executa JavaScript customizado dentro do seu fluxo de trabalho.
|
|
|
|
**Configuração**:
|
|
|
|
- Escreva o código JavaScript no editor
|
|
- Acesse variáveis de etapas anteriores
|
|
- Retorne variáveis para uso nas etapas subsequentes
|
|
- Teste o código diretamente na etapa
|
|
|
|
**Acesso**: Gerencie chaves de API em Configurações → API & Webhooks
|
|
|
|
### Formulário
|
|
|
|
Solicita um formulário durante a execução do fluxo de trabalho para coletar a entrada do usuário.
|
|
|
|
**Configuração**:
|
|
|
|
- Defina campos de entrada com tipos, rótulos e espaços reservados
|
|
- Configure regras de validação
|
|
- Defina título e descrição do formulário
|
|
|
|
**Saída**: Respostas do formulário estão disponíveis para uso em etapas subsequentes.
|
|
|
|
<Warning>
|
|
Formulários são atualmente projetados apenas para acionadores manuais. Para fluxos de trabalho com outros gatilhos (Registro Criado, Atualizado, etc.), os formulários são acessíveis apenas via a interface de execução de fluxo de trabalho, o que não é a experiência esperada para o usuário. Um centro de notificações será lançado em 2026 para suportar adequadamente formulários em fluxos de trabalho automatizados.
|
|
</Warning>
|
|
|
|
### Requisição HTTP
|
|
|
|
Envia uma requisição para uma API externa como parte do seu fluxo de trabalho.
|
|
|
|
**Configuração**:
|
|
|
|
- Insira o URL do endpoint da API
|
|
- Selecione o método HTTP (GET, POST, PUT, PATCH, DELETE)
|
|
- Adicione cabeçalhos e valores necessários
|
|
- Inclua o corpo da requisição para requisições POST/PUT/PATCH
|
|
- Forneça resposta de amostra para visualização de estrutura
|
|
|
|
## Workflow Management
|
|
|
|
### Creating Workflows
|
|
|
|
1. Click "+ Add a Workflow" to begin
|
|
2. Click "Untitled" to name your workflow
|
|
3. Choose and configure your workflow trigger
|
|
4. Add actions to your workflow
|
|
5. Teste e itere
|
|
6. Ative seu fluxo de trabalho (atualmente em modo de rascunho) uma vez que terminar de editá-lo
|
|
|
|
**Nota**: Se não vir a seção de Fluxos de Trabalho, isso ocorre devido a uma questão de permissões. Entre em contato com o administrador do seu espaço de trabalho para lhe conceder acesso aos fluxos de trabalho.
|
|
|
|
### Workflow Statuses
|
|
|
|
- **Rascunho**: Sendo editado, ainda não publicado
|
|
- **Ativo**: Versão ativa respondendo a disparadores
|
|
- **Desativado**: Anteriormente ativo, mas interrompido manualmente
|
|
- **Arquivado**: Versões passadas mantidas para histórico
|
|
|
|
### Activating Workflows
|
|
|
|
Click **Activate** to publish your draft as a new version. This makes the workflow eligible to run when triggered but doesn't immediately execute it.
|
|
|
|
### Testing Workflows
|
|
|
|
Test workflows before activation using:
|
|
|
|
- Manual triggers (when no record selected)
|
|
- Individual action testing (especially Code actions)
|
|
- Draft mode testing that doesn't activate the workflow
|
|
|
|
### Execuções do Workflow
|
|
|
|
A **Run** is a record of workflow execution containing:
|
|
|
|
- Status (success, failed, running)
|
|
- Output data from each step
|
|
- Author and timestamps
|
|
- Error messages if applicable
|
|
|
|
**Visualizando Execuções**:
|
|
|
|
- Verifique o painel **Execuções** no editor de fluxo de trabalho
|
|
- Abra a visualização **Execuções de Fluxos** para monitoramento em todos os fluxos de trabalho
|
|
|
|
**Dica de Desempenho**: Ocultar execuções de fluxo de trabalho da página "Todos os fluxos de trabalho" e outras páginas de fluxo de trabalho para melhorar o desempenho de carregamento, pois grandes números de execuções podem atrasar o carregamento da página.
|
|
|
|
### Version History
|
|
|
|
- View all versions under the **Versions** field
|
|
- Click any version to view details
|
|
- Use **Use as draft** to restore previous versions
|
|
- Handle draft conflicts with override or return options
|
|
|
|
## Melhores Práticas
|
|
|
|
### Organização de Flows de Trabalho
|
|
|
|
- **Nomes Descritivos**: Utilize nomes de fluxo de trabalho claros e específicos
|
|
- **Nomeação de Etapas**: Renomeie etapas para descrever sua função
|
|
- **Documentação**: Adicione comentários em ações de Código
|
|
- **Categorização**: Agrupe fluxos de trabalho relacionados logicamente
|
|
- **Campos Personalizados**: Adicione campos ao objeto de Fluxo de Trabalho em seu modelo de dados (semelhante a outros objetos) para organizar e categorizar fluxos de trabalho com propriedades personalizadas
|
|
|
|
### Otimização de Desempenho
|
|
|
|
- **Minimize Chamadas de API**: Agrupe operações quando possível
|
|
- **Buscas Eficientes**: Utilize critérios de filtro específicos
|
|
- **Manejo de Erros**: Planeje para cenários de falha
|
|
- **Limitação de Taxa**: Respeite os limites de API externos
|
|
|
|
### Gerenciamento de Fluxo de Dados
|
|
|
|
- **Lógica de Ramificação**: Use ramificações após Pesquisar Registros
|
|
- **Uso de Variáveis**: Utilize dados de etapas anteriores
|
|
- **Validação de Dados**: Valide entradas em ações de Código
|
|
- **Mapeamento de Campos**: Planeje transformações de dados com cuidado
|
|
|
|
### Monitoramento e Manutenção
|
|
|
|
- **Regular Monitoring**: Check workflow runs for errors
|
|
- **Revisão de Desempenho**: Analise tempos de execução e taxas de sucesso
|
|
- **Gerenciamento de Atualizações**: Teste mudanças em rascunho antes da ativação
|
|
- **Coordenação de Equipe**: Documente fluxos de trabalho para os membros da equipe
|
|
|
|
Para exemplos práticos dessas funcionalidades em ação, veja nossos guias de [Automatizações Internas](/l/pt/user-guide/workflows/internal-automations) e [Integração de Ferramentas Externas](/l/pt/user-guide/workflows/external-tool-integration).
|