NotificationRun
A request or response body; the type column links to the schemas it refers to.
NotificationRun
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | — |
| trigger | string | yes | `scheduled`: claimed by the cron tick. `manual`: a superuser's run-now. one of "scheduled" | "manual" |
| due_at | string (date-time) | yes | The scheduled occurrence the run is for; the request time of a manual run. |
| status | string | yes | `running` until every recipient has been processed — a large batch spans several ticks — then `completed`. one of "running" | "completed" |
| started_at | string (date-time) | yes | — |
| finished_at | string (date-time) | null | yes | — |
| sent_count | integer | yes | minimum 0 |
| skipped_count | integer | yes | Recipients with nothing due and no upcoming event, or with no email address. minimum 0 |
| failed_count | integer | yes | Recipients whose email the mail server refused or that failed validation. minimum 0 |
jsonExample
{
"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
}