Automations
Automations run an action when something happens: on a schedule or when an event arrives, on a set of projects or nodes. Create and edit them, preview which targets a rule reaches, and read their runs.
List automations
Lists the organization's automations by name, each with its When, Target, Action, status and last and next run. Filters by when kind and status. Requires the Org Owner or Org Admin role.
Create automation
Creates an automation and its schedule or event source and returns it, with a signed event source's secret shown only this once. An empty or out-of-organization target, or an action the caller may not use, returns 422. Requires the Org Owner or Org Admin role.
List automation action types
Lists the action types the caller may create, with whether each takes a target, the target kinds and when kinds it accepts. Requires the Org Owner or Org Admin role.
Automation by legacy
Returns the automation a schedule or trigger id belongs to. Requires the Org Owner or Org Admin role.
Preview automation target
Resolves a target rule now and returns the targets it reaches, how many of the total, and any stored ids that no longer name a target. Requires the Org Owner or Org Admin role.
List automation targets
Lists what an automation of the organization can target: its dispatchable projects the caller can see, or the nodes it may use with their state. Requires the Org Owner or Org Admin role.
Delete automation
Deletes an automation and its schedule or event source; tasks it filed keep its name. Requires the Org Owner or Org Admin role. Returns 204 with no body.
Get automation
Returns one automation with its When, Target, Action and status. The secret is never returned. Requires the Org Owner or Org Admin role.
Update automation
Changes only the fields sent on an automation and returns it. Changing the When kind replaces its schedule or event source and returns a new secret when one is made. Requires the Org Owner or Org Admin role.
Upload automation attachment
Uploads one file onto an automation's Task action, within the task upload limits, and returns it. Save its id in the action's attachments so each task carries a copy. Requires the Org Owner or Org Admin role.
Delete automation attachment
Removes one file from an automation's Task action. Requires the Org Owner or Org Admin role. Returns 204 with no body.
List automation dedup
Lists an event automation's duplicate store. Requires the Org Owner or Org Admin role.
Clear automation dedup
Clears one entry from an event automation's duplicate store, so the same item can file a task again. Requires the Org Owner or Org Admin role. Returns 204 with no body.
List automation deliveries
Lists an event automation's deliveries, newest first, filtered by outcome. Requires the Org Owner or Org Admin role.
Pause automation
Pauses an automation, so it stops running until resumed, and returns it. Requires the Org Owner or Org Admin role.
Resume automation
Resumes a paused or stopped automation and returns it. Requires the Org Owner or Org Admin role.
Reveal automation secret
Returns an event automation's secret once, while its one reveal is still owed. Returns 409 once it has been shown. Requires the Org Owner or Org Admin role.
Rotate automation secret
Issues a new secret for an event automation, shown only this once; the old one stops working at once. Requires the Org Owner or Org Admin role.
Run automation
Runs a scheduled automation once now and returns whether a run was queued. An event automation returns 501. Requires the Org Owner or Org Admin role.
List automation runs
Lists an automation's runs, newest first, each with its cause, time, outcome, detail and the task it filed. `limit` is at most 200. Requires the Org Owner or Org Admin role.
Test render automation
Renders an event automation's templates against a sample event without filing anything. Requires the Org Owner or Org Admin role.