Creating a Workflow
- How to navigate to the workflow creation form
- How to fill in each field: name, enabled toggle, log level, trigger, and steps
- How to save and test your new workflow
Creating a workflow lets you automate a series of actions that run whenever a specific condition is met -- whether that is a scheduled time, a system event, or a manual button press.
Step-by-step: create a new workflow
1. Open the workflows list
Navigate to Automacoes > Workflows in the sidebar. This opens the workflows list page, which shows all of your existing workflows.
2. Click the add button
Click the workflow_add button in the top area of the page. This opens the workflow creation form.
3. Enter the workflow name (Nome)
In the Nome field, type a descriptive name for your workflow. Choose something that clearly describes what the workflow does, such as "Welcome message for new clients" or "Daily appointment reminder."
4. Enable or disable the workflow (Ativado)
Use the Ativado checkbox to control whether the workflow is active. When checked, the workflow is enabled and will run when its trigger condition is met. Leave it unchecked while you are still building and testing.
5. Set the log level (Nivel do Log)
Select a Nivel do Log (Log Level) from the dropdown. This controls how much detail is recorded each time the workflow runs. A higher log level captures more information, which is helpful during testing and troubleshooting. A lower level reduces noise once the workflow is running smoothly in production.
6. Configure the trigger (Gatilho)
Under the Gatilho section, choose a Tipo (Type) from the dropdown. There are three options:
| Trigger type | When to use it |
|---|---|
| temporal | You want the workflow to run on a schedule (e.g., every morning, once a week) |
| hook | You want the workflow to fire when a specific event happens (e.g., a new message is received, a client is created) |
| manual | You want an employee to start the workflow by hand whenever needed |
After selecting the trigger type, additional configuration fields may appear depending on your choice. See Trigger types for full details on each option.
7. Add steps (Etapas)
In the Etapas section, click the Adicionar passo (Add step) button to add your first step. Each step represents one action the workflow will perform. You can add as many steps as you need, and they will execute in order from top to bottom.
The Etapas section also provides two utility buttons:
- Depurar tudo (Debug all) -- Runs all steps in debug mode so you can inspect how each one behaves
- Limpar todos os itens (Clear all items) -- Removes all steps at once, letting you start over
See Workflow steps for details on configuring individual steps.
8. Save the workflow
Once you have configured the name, trigger, and steps, save the workflow. After saving, additional options become available, including the executeManual button for testing manual-trigger workflows.
Testing your workflow
Keep your workflow disabled (Ativado unchecked) while building and testing. Once you are confident it works correctly, check the Ativado box to activate it for production use.
- For manual workflows: After saving, click the executeManual button to trigger the workflow on demand. This button is only available after the workflow has been saved.
- For hook workflows: Trigger the relevant event in the system (e.g., create a test client) and then check the execution history to verify the workflow ran.
- For temporal workflows: Wait for the scheduled time, or temporarily adjust the schedule to a near-future time for testing.
Use the Depurar tudo (Debug all) button in the Etapas section to step through your workflow and inspect how each step processes data before going live.