Creating a flow
You can create a flow from a template or build one yourself. Templates are the quickest way to start; a custom flow gives you full control over the trigger, filters and action.
Before you start: you need permission to manage automations (admins and owners by default). For an agent flow, set up the agent first, or use a template that creates one for you.
Start from a template
Go to Automation → Flows and select New flow.
Browse the templates, or type in Search templates.... Use the category tabs to filter the list.
Select a template.
Fill in the template's inputs, such as a repository or docs space. Under Flow details, you can change the Flow name and Internal description.
If the template creates an agent, review Agent setup: the Agent name, Run approval, Instructions and, under Capabilities, its working areas, tools and skills.
Optionally add Additional instructions for the agent.
Select Review setup if it appears, check the summary, then select Install.
The new flow appears in your list and is active straight away. Select ← Back to templates at any point to pick a different template.
Build a custom flow
Go to Automation → Flows and select New flow.
Select Build a custom flow.
Enter a Flow name and, optionally, an Internal description explaining what the flow is for.
Under When, choose a trigger, such as Task enters a workflow state, GitHub pull request merges or Schedule ticks.
Fill in the filters that appear for that trigger, such as workflow and state, repository, or branch. See Flow filters and conditions.
Optionally, add a Semantic condition in plain language.
Under then, choose an action. For Start an agent run, choose the agent after using.
Under on, choose where the agent works. See Flow targets.
Read the Flow summary to check the flow does what you expect.
Select Create flow.
Only the fields that apply to your trigger and action appear. If Create flow is disabled, hover over it to see what's missing, for example Choose an agent or Add a repository or branch filter.
Set a schedule
When you choose Schedule ticks, pick how often the flow runs:
Simple builder – choose Every hour, Every day, Every week or Every month, then the minute, time, weekdays or day of the month. Times use your workspace time zone.
Advanced cron – enter a cron expression, such as
0 9 * * 1.
Scheduled flows can't use the event that triggered them as a target, so choose a specific item or this workspace under on. See Run a flow on a schedule.
Check your flow
After the trigger next fires, open the flow and look at Recent runs, or go to Automation → Activity. For scheduled flows, you can select Run now to test the flow straight away.
Related articles
Was this article helpful?