NotificationTickResult

A request or response body; the type column links to the schemas it refers to.

NotificationTickResult

Field	Type	Required	Description
outcome	string	yes	`disabled`: the schedule is off. `nothing_due`: no occurrence since the last claimed one and no run left to resume. `busy`: another invocation is still working on a run, so nothing was started (a due occurrence waits for the next tick). `ran`: a run was started or resumed (see `run`). one of "disabled" \| "nothing_due" \| "busy" \| "ran"
run	any	yes	—
processed	integer	yes	Recipients handled by this invocation. minimum 0

Field

Type

Required

Description

outcome

string

yes

`disabled`: the schedule is off. `nothing_due`: no occurrence since the last claimed one and no run left to resume. `busy`: another invocation is still working on a run, so nothing was started (a due occurrence waits for the next tick). `ran`: a run was started or resumed (see `run`).

one of "disabled" | "nothing_due" | "busy" | "ran"

run

any

yes

—

processed

integer

yes

Recipients handled by this invocation.

minimum 0

jsonExample

{
  "outcome": "disabled",
  "run": null,
  "processed": 0
}