NotificationSchedule
A request or response body; the type column links to the schemas it refers to.
NotificationSchedule
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | Whether the cron tick sends anything. |
| cadence | string | yes | `daily`: every day at the hour. `weekly`: on `weekday` only. one of "daily" | "weekly" |
| weekday | integer | yes | Day of the week, 0 = Sunday … 6 = Saturday; used when weekly. minimum 0 · maximum 6 |
| hour | integer | yes | Hour of the day, 0–23, on the wall clock of `timezone`. minimum 0 · maximum 23 |
| timezone | string | yes | IANA timezone the hour is read in. 1–64 characters |
| next_due_at | string (date-time) | null | yes | The next occurrence the schedule will claim, or null while disabled. The hourly tick sends within the hour that follows it. |
| last_due_at | string (date-time) | null | yes | The most recent occurrence a tick claimed, or null if none has run yet. |
| updated_at | string (date-time) | yes | — |
| recent_runs | array of NotificationRun | yes | The latest runs, newest first. |
jsonExample
{
"enabled": true,
"cadence": "weekly",
"weekday": 1,
"hour": 7,
"timezone": "America/New_York",
"next_due_at": "2026-01-01T00:00:00.000Z",
"last_due_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"recent_runs": [
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"trigger": "scheduled",
"due_at": "2026-01-01T00:00:00.000Z",
"status": "running",
"started_at": "2026-01-01T00:00:00.000Z",
"finished_at": "2026-01-01T00:00:00.000Z",
"sent_count": 0,
"skipped_count": 0,
"failed_count": 0
}
]
}