Background Tasks

Next run

Next run reads the open workflow. A paused communication workflow reports health paused, mechanism none, no next time, and event as its only trigger.

get/v1/background-tasks/{slug}/schedule-state

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/background-tasks/{slug}/schedule-state
Auth: HTTP bearer

slugstring required

Workflow address.

Example:follow-up-when-a-promise-slips

Workflow to read.

Next run.

health'paused' | 'current' | 'failed' | 'unknown' | 'syncing' required

Whether the next run is ready.

lastEvaluatedAtstring date-time nullable

When the schedule was last checked.

lastTriggeredAtstring date-time nullable

When it last started.

mechanism'none' | 'desktop_loop' | 'rowboat_loop' | 'temporal_schedule' required

What owns the schedule.

nextDueAtstring date-time nullable

When it is due next.

scheduleSyncState'current' | 'syncing' | 'failed' | 'paused'

Whether a timed cloud schedule matches the workflow.

sourcesobject

One entry for each trigger.

target'api' | 'desktop' required

Where this workflow runs.

triggerSourcesstring[] required

What can start this workflow.

{
  "health": "paused",
  "mechanism": "none",
  "target": "api",
  "triggerSources": [
    "event"
  ]
}

No operation changes recorded.