For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a Task

Create a scheduled task.

Where: Tasks β†’ Tasks β†’ Add New Β· /projects/<project>/tasks/new

Add new scheduled task is one form: name the task, write the cron expression, pick the user it runs as, and configure the command it runs.

Screenshot TODO β€” capture comes from testing-plan area 12-scheduler.

Step by step

  1. Basic info β€” Name (required, e.g. "Daily welcome email digest") and an optional Description for you and your team.

  2. Schedule β€” the Cron expression, standard crontab syntax (minute hour day month weekday). As you type, the form shows a plain-English explanation and the next run time β€” for example 0 8 * * 1 reads "At 08:00 on Monday", next run Monday 08:00. A legend below the input lists the five fields, their allowed values, and the * , - / symbols. The form accepts 5- or 6-field expressions; the gateway validates the value strictly when you save.

  3. Run as user β€” the Initiator user (required). The scheduled command executes with this user's permissions, so pick one with the rights the implementation needs. The form recommends a dedicated service user over a real person β€” stable identity, clear in audit logs, does not break when someone leaves β€” and offers Create service user right in the picker.

  4. Implementation β€” the Command drop-down: Email, Push, Sms, Code call, Webhook call. Only Email can be configured today; any other choice shows a "coming soon" note. Picking Email opens the email-campaign sub-form β€” the same recipients, template and sending options as Create a Campaign, minus the send button: the schedule sends instead. The Email module must be enabled; if it is off, an alert appears and Save is disabled.

  5. Behaviour β€” two toggles: Enabled (on by default β€” the cron starts firing right after save) and Auto-disable on error (off by default β€” when on, the task disables itself the first time a run fails).

Save submits the task and returns you to the Tasks list; the new task gets an id (tsk_…). Cancel goes back without saving.

Example

Name "Weekly onboarding digest", cron 0 8 * * 1, initiator a service user, command Email with the "Onboarding digest" template to all users in the trial role β€” every Monday at 08:00 the campaign goes out, no one has to press Send.

Use it from code

Save Scheduler Task

API reference

Endpoints: Save Scheduler Task.

Last updated