Comment on page
API Workflow Scheduler
This section covers the Scheduler, which lets you view, pause and delete upcoming scheduled workflows
A scheduled workflow (known as an API Workflow) is a workflow that is scheduled to run on the Bubble server at a specific time. In the Logs tab of your application editor, you can access the Scheduler to view all upcoming scheduled workflows.
The Live and Development environments in your app have separate schedules. If you don't see workflows that you expected to be in the list, check that you are looking at the right environment.
The scheduler is a queue, and can be imagined as a funnel. If a funnel is filled with water faster than the rate at which it drains, it will be congested and it will affect its flow. Similarly, if the scheduler is "filled" with a lot of simultaneous or very shortly spaced workflows, the scheduler can be "congested", leading to delays.
To avoid delays when working with scheduled workflows, follow the recommendations below:
- The more heavy the workload of the workflow, the more server capacity it will use. This is both affected by the number of actions in the workflow, and the complexity of those workflows
- Database operations that work on a large volume of data (searches (especially with advanced filters) and actions that work on a list of things are particularly taxing
- A high number of actions, and in particular if they depend on each other (such as using result of step X) can also slow things down
- If you are scheduling a big number of workflows (by use of Schedule API Workflow on a list or recursively), it helps to consider spacing them out with some time in-between each cycle. How much time depends on the complexity of the workflow and how much capacity your app has in general
- If the process does not need to finish at the highest possible speed, you can experiment setting a delay time of several seconds to control the capacity.
Overall, server-side workflow are a very powerful feature, but you may find that you need to experiment a bit to learn how to build workflows that don't overwhelm the system.
To search for scheduled workflows, set a time in the datetime input and click Show. Bubble will search for all workflows that are scheduled after the time you have specified. Note that the search can take a little bit of time to finish.
The columns let you see the details for that specific workflow:
Scheduled time is the datetime when the workflow is scheduled to run. It will show in the timezone reported by your browser (meaning it may look different to you and the user who scheduled it if you are not in the same timezone).
ID is the ID of the scheduled workflow. Every workflow that is scheduled has a unique ID used to identify that workflow.
API Event is the event of the workflow, recognized by the label you have given it in the Workflow editor.
Current user is the email of the user that scheduled the workflow
Parameters include any custom parameters that were provided when the workflow was scheduled
Be careful when using the Pause tasks feature, as this will stop all API Workflows from running; if you are working in the Live environment and have live users scheduling API workflows, they will not run until Pause tasks has been deactivated.
If you are experiencing workflows not running as expected, check this setting.
Click here to pause upcoming workflows. If they are already on pause, this will read “Resume tasks,” which you can click in order for scheduled workflows to run again.
You can delete all past workflows that have not run yet, or scheduled workflows in their entirety.
No, since workflow API requests that come from an external app are not scheduled but triggered immediately, they will not show up in the scheduler.
An API workflow scheduled in the past will trigger immediately, and as such will not show up in the scheduler.