Skip to main content

Schedule Brick

PurposeLearn about the various configurations and parameters required for the Schedule Brick to function correctly.
Last updatedAugust 02, 2024

What is a Schedule Brick?​

A Schedule Brick is a Trigger Brick that allows a playbook to run at a fixed time or as frequently as the user wants. This functionality enables users to schedule the playbook to perform tasks at certain intervals so that the required actions are completed at the right time. This is very helpful especially in daily checks, data gathering, and any other activities that are time-sensitive.

Schedule Brick configuration supporting video​

Schedule Brick Parameters​

  1. Label: This is where the user can provide a name for the brick.

  2. Prompt: Here, the user sets the fixed time for the playbook to be triggered using natural language. This section is powered by ChatGPT to generate and fill in the Cron section.

    • Prompt Example:

Every first day of the month at 14:00

  1. Cron: This section is used to schedule tasks to run periodically at specific times, dates, or intervals. The * character is a wildcard representing all possible values in its field.

Only one of the Prompt or Cron parameters are necessary.

  • Cron Example:
┌──────── minute (0 - 59)
│ ┌──────── hour (0 - 23)
│ │ ┌──────── day of the month (1 - 31)
│ │ │ ┌──────── month (1 - 12)
│ │ │ │ ┌──────── day of the week 
│ │ │ │ │
│ │ │ │ │
0 9 * * *
  • This example schedules the brick to run at 9 AM every day.
  • * is a wildcard representing all possible values within its field.

For more information about cron, follow the link below:

Learn more about cron

Schedule Brick Output Format​

In this section of the documentation the user will learn where are the outputs of the brick stored and its format.

  • No output is passed to the next brick in the sequence.