You can configure modules to run automatically on a defined schedule, e.g., to send automatic email reminders, verify the status of follow-up tasks (e.g., by retrieving the DocuSign eSignature status), or trigger actions when specific criteria are met (e.g., first day of a quarter, a threshold is reached, or a task is overdue).
This feature allows you to execute headless modules (modules that can run without any user input) in the Live environment at regular intervals, such as daily, weekly, or monthly.
How to Schedule a Module
- Open your Application and select the module you want to schedule.
- Click Schedule in the module's three-dot icon menu.
- Choose the frequency and time at which the module should run.
- You can select to run it daily, weekly, or monthly at a specific time.
- If you deselect the initial time option, the module will run every hour.
- You can also select multiple hours to run the module several times per day.
- Click Save to activate the schedule.
Once a schedule is set, a clock icon appears next to the Live environment to indicate that it runs automatically.
To delete the schedule, follow the above steps to access the scheduling modal where you will be able to select the Delete schedule option.
Example: Creating custom schedules
If a configuration option is not available, for instance, if you want a module to run quarterly, you can schedule it to run on the first day of each month and include a condition within the module to check whether it’s, for example, the first day of a quarter.
If the condition is met, the module continues to execute its actions (e.g., sending an automatic email reminder or generating a report). If not, it simply ends. This approach allows you to implement more complex timing logic within your module.
Requirements
To schedule a module, make sure that:
- The module does not contain any input nodes, so that it can be executed without pausing to wait for user input.
- The module is published to the Live environment, this is the only environment schedulers can be attached to at the moment.
Only modules that meet these criteria can be scheduled for automatic execution.
Testing note: Before scheduling, you can manually trigger the module to verify that it behaves as expected. Once it runs successfully manually, it will also execute correctly on the schedule when published to Live.