Criando um Workflow
- Como navegar até o formulário de criação de workflow
- Como preencher cada campo: nome, toggle de ativação, nível de log, trigger e etapas
- Como salvar e testar seu novo workflow
Um workflow automatiza uma série de ações que executam em um cronograma, em resposta a um evento do sistema ou quando um funcionário o inicia manualmente.
Passo a passo: criar um novo workflow
1. Abra a lista de workflows
Navegue até Automações > Workflows na barra lateral. Isso abre a página de lista de workflows, que mostra todos os seus workflows existentes.
2. Clique no botão adicionar
Clique no botão de ícone + (tooltip "Adicionar workflow") na área superior da página. Isso abre o formulário de criação de workflow.
3. Insira o nome do workflow
No campo Nome, digite um nome para o seu workflow, como "Mensagem de boas-vindas para novos contatos" ou "Lembrete diário de consultas."
4. Habilite ou desabilite o workflow
Use a caixa de seleção Ativado para controlar se o workflow está ativo. Quando marcada, o workflow está habilitado e executará quando sua condição de trigger for atendida. O workflow precisa estar habilitado para executar -- incluindo execuções de teste sob demanda de workflows manuais ou temporais pelo botão Executar, que fica oculto enquanto o workflow está desabilitado. (Veja Testando seu workflow mais abaixo para o ciclo recomendado de habilitar, executar e depois desabilitar.)
5. Defina o nível de log
Selecione um Nível do Log no dropdown. Isso controla quanta informação é registrada cada vez que o workflow executa. Um nível de log mais alto captura mais informações, o que é útil durante testes e resolução de problemas. Um nível mais baixo reduz ruído quando o workflow está funcionando em produção.
6. Configure o trigger
Na seção Gatilho, escolha um Tipo no dropdown. Existem três opções:
| Tipo de trigger | Quando usar |
|---|---|
| temporal | Você quer que o workflow execute em um cronograma (ex.: toda manhã, uma vez por semana) |
| hook | Você quer que o workflow dispare quando um evento específico acontecer (ex.: uma nova mensagem é recebida, um contato é criado) |
| manual | Você quer que um funcionário inicie o workflow manualmente quando necessário |
Após selecionar o tipo de trigger, campos de configuração adicionais podem aparecer dependendo da sua escolha. Veja Tipos de trigger para detalhes completos sobre cada opção.
7. Adicione etapas
Na seção Etapas, clique no botão Adicionar passo para adicionar sua primeira etapa. Cada etapa representa uma ação que o workflow executará. Você pode adicionar quantas etapas precisar, e elas executarão em ordem de cima para baixo.
A seção Etapas também tem dois controles utilitários:
- Iniciar Debug (ao lado do rótulo da seção) -- Executa cada etapa pelo loop de ações real para que você possa inspecionar como cada uma se comporta. Isto não é uma simulação: chamadas HTTP, gravações de dados e mensagens de saída reais são disparadas.
- O botão de ícone de lixeira (limpar todos os itens) -- Remove todas as etapas de uma vez
Veja Etapas do workflow para detalhes sobre configuração de etapas individuais.
8. (Opcional) Defina uma expressão de retorno
Se o seu workflow usa um trigger manual ou temporal, um campo opcional Expressão de retorno aparece (ele fica oculto para triggers hook). Insira aqui uma expressão CEL para calcular um valor de retorno. Depois que todas as etapas terminam, essa expressão é avaliada e o resultado se torna o valor de retorno do workflow -- o que o modal Executar exibe e o que um workflow pai ou encadeado recebe ao chamar este. Deixe em branco se o workflow não precisar retornar nada.
9. Salve o workflow
Depois de configurar o nome, trigger e etapas, salve o workflow. Após salvar, o botão Executar aparece para workflows com trigger manual e temporal (quando Ativado está marcado), permitindo executá-los sob demanda.
Testando seu workflow
O botão Executar só aparece -- e só funciona -- quando o workflow está habilitado (Ativado marcado), e somente depois de salvo. Para testar um workflow manual ou temporal sob demanda, habilite-o, salve, execute-o e depois desmarque Ativado novamente se ainda não estiver pronto para produção. (Workflows hook não têm botão Executar -- você os testa acionando o evento subjacente.)
- Para workflows manuais: Habilite e salve o workflow, depois clique no botão Executar para acioná-lo sob demanda.
- Para workflows hook: Acione o evento relevante no sistema (ex.: crie um contato de teste) e depois verifique o histórico de execução para confirmar que o workflow executou.
- Para workflows temporais: O mesmo botão Executar fica disponível assim que o workflow está habilitado, então você pode acioná-lo sob demanda em vez de aguardar o horário agendado. Você também pode aguardar a próxima ocorrência agendada.
Use o botão Iniciar Debug na seção Etapas para percorrer seu workflow e inspecionar como cada etapa processa dados. Note que Iniciar Debug executa cada etapa de forma real (chamadas HTTP, gravações de dados e mensagens são disparadas) -- não é uma prévia sem efeitos colaterais.