> ## Documentation Index
> Fetch the complete documentation index at: https://docs.summation.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Schedules
> Run a playbook automatically — on a cadence you pick, delivered to email and Slack.
A **schedule** runs a [playbook](/features/artifacts/playbooks) automatically — once at a set time, or daily, weekly, or monthly. Each run produces that playbook's [artifacts](/features/artifacts) in its [project](/features/projects), just like running it by hand, and can deliver them straight to your inbox or a Slack channel. Set up the Monday-morning recap once and it lands before anyone asks for it.
**Where each action lives in the UI** (for telling users where to click):
* **Schedules home**: the **Schedules** entry in the left nav sidebar (`/schedules`) — a table with **Name** (the cadence is the row's subtitle), **Playbook**, **Last run**, **Next run**, and **Created by**, plus **Search** and a **New schedule** button at the top-right. Each row has a **⋯** menu: **Edit**, **Pause** / **Resume**, **Run now**, **Delete**.
* **Schedule details**: click a row to open the right-hand sidebar (`/schedules?scheduleId={id}`) — the cadence, **Next run** (or **Status** once it's terminal), **Parameters**, **Recipients**, and a **History** timeline of past runs, with **Edit**, **Pause** / **Resume**, **Run now**, and a delete control.
* **New schedule wizard** — **Schedule Playbook**, three steps: (1) **pick a playbook** from a searchable list showing each playbook's project; (2) fill in its **Runtime Parameters**, if it has any; (3) set **Name**, **Frequency**, and delivery. **Previous** steps back; the final button is **Create schedule**.
* **From a playbook**: the **Schedule** button in a playbook's toolbar, or **Schedule** in its run dialog, opens the same wizard with that playbook already picked. See [Schedule a playbook](/features/artifacts/playbooks#schedule-a-playbook).
* **Frequency** in the UI is `Once`, `Daily`, `Weekly`, or `Monthly`. Weekly adds a **multi-select weekday picker** (one or more days), monthly a day-of-month picker, and `Once` a date. Times come in 15-minute increments (default `9:00 AM`) in a **selectable timezone**, which defaults to the browser's.
* The **API** accepts a wider cadence set than those four UI options: `cron`, `interval`, `one_time`, `daily`, `weekly`, `biweekly`, `monthly`, `month_end`, and `yearly`. Note the one-time value is `one_time`, not `once`.
* Schedule states: **active** and **paused** are the only stored states. A one-time schedule that has run reads **completed**, or **failed** if its single run failed; a **recurring** schedule stays **active** even when its runs keep failing. A schedule mid-run shows **Running**.
* Email recipients can unsubscribe themselves from a signed link in the email — no sign-in needed.
The Schedules home (`/schedules`) and the per-playbook schedule indicator are gated by the `ui_schedules_home_v1` feature flag; playbook surfaces themselves are gated by `ui_project_runbooks`. If a workspace has one off, that part of the UI won't appear.
## Create a schedule
Click **New schedule** (top-right of `/schedules`) and pick the playbook to run — the list is searchable and shows each playbook's project. You can also start from the playbook itself: **Schedule** in its toolbar or run dialog opens the same wizard with the playbook already chosen.
If the playbook takes **runtime parameters** — a week-ending date, a market, a team — the next step asks for the values this schedule should use on every run.
Create a schedule for a playbook.
## Set the cadence
Give the schedule a **Name**, then pick a **Frequency**:
| Frequency | What you set |
| ----------- | ------------------------------------------------------------------------------ |
| **Once** | A date and time — the schedule runs a single time, then shows as **completed** |
| **Daily** | A time of day |
| **Weekly** | One or more weekdays, plus a time |
| **Monthly** | A day of the month, plus a time |
Times are picked in 15-minute increments and interpreted in a timezone you choose — your browser's by default — which is stored with the schedule so runs stay put when you travel.
Update a schedule's cadence, parameters, or delivery.
`PUT` is a **full replace** — the body is a complete create request, so any `config` field you leave out resets to its default (`params={}`, `output_folder="/Reports"`, `email_recipients=[]`, `paused=false`). A PUT that carries only a new cadence silently wipes the recipients. **Read the schedule first, change the fields you mean to, and send the whole object back.**
## Deliver the results
A scheduled run always saves its artifacts into the project. Turn on either notification to push them out as well.
**Email notification** — add recipients, then pick which artifacts to attach. Each artifact has a single **attach** checkbox; a link to the artifact is always included, whether or not it's attached. Recipients must be on your workspace's allowed email domains. Recipients can unsubscribe themselves from a link in the email.
**Slack notification** — post to channels or people in a connected [Slack workspace](/features/connectors), with the same per-artifact attach checkbox.
**How each artifact arrives.** Formats that are already final ship as themselves; the rest render to PDF:
| Artifact | Attached as |
| --------------------------------------------------- | -------------------- |
| **[Report](/features/artifacts/reports)** (`.sdoc`) | PDF |
| **HTML page** | PDF |
| **[Deck](/features/artifacts/decks)** (`.sdeck`) | PowerPoint (`.pptx`) |
| **Workbook** (`.xlsx`) | Excel |
| **PDF** | PDF |
Playbooks that declare their outputs get a row per output. For playbooks that don't, the scheduler discovers the artifacts after the run and applies these same per-kind defaults.
Set email recipients when creating a schedule.
Recipients must be on the workspace's invite-domain allowlist — a disallowed address returns `400 RECIPIENT_DOMAIN_NOT_ALLOWED`. **Slack can't be set through this call**: the public config model has no `slack_recipients` field and silently drops one if you send it. Per-artifact delivery isn't exposed here either — it requires hand-building `config.output_config.email.artifacts`.
## Find and manage schedules
The **Schedules** page (`/schedules`, shown above) lists your schedules with the playbook each one runs, when it last ran, when it runs next, and who created it — with search. Click a row to open its details sidebar: the cadence, next run, the parameter values it runs with, and a history of past runs.
Each schedule's **⋯** menu (and the sidebar) holds the rest:
| Action | What it does |
| ---------------------- | ---------------------------------------------------------------------- |
| **Edit** | Reopen the wizard to change the cadence, parameters, or delivery |
| **Pause** / **Resume** | Stop future runs without deleting the schedule, then start them again |
| **Run now** | Run the playbook immediately, without waiting for the next occurrence |
| **Delete** | Remove the schedule. Artifacts it already produced stay in the project |
List schedules.
Show a single schedule.
Pause a schedule.
Resume a schedule.
Delete a schedule. Requires `confirm=true`.
## Run history
A schedule's **History** timeline — in its details sidebar, shown above — lists each run with what it produced; open a run to jump to the artifact, or to the chat behind it. Runs in flight show as **In progress** with a live dot, finished runs are check-marked, and a failed run carries its reason.
A schedule itself reads as **active** or **paused**; a one-time schedule that has already run reads **completed**, or **failed** if its single run failed. A recurring schedule stays **active** even when its runs keep failing. Runs from a schedule also appear in the **Runs** tab on the [Playbooks](/features/artifacts/playbooks#run-history) page, alongside runs people started by hand.
List a schedule's runs.
Run a schedule's playbook immediately.