automations_write
Arguments
ID!
required
The automation’s id.
String
A key of your choosing. Repeating a call with the same key returns the first run rather than starting another.
Returns
One execution of an automation. Runs are deleted 30 days after they finish.
Show fields
Show fields
required
The automation this run belongs to.Requires:
automations_readShow fields
Show fields
Boolean!
required
Whether the automation runs when its trigger fires. Change it with
automationUpdate.ID!
required
The id of this automation.
String!
required
The automation’s name.
Int
The latest published version; null until first published.
String!
required
The draft’s revision. Opaque; pass it to
automationPublish as expectedRevision.required
Runs, newest first. Runs are deleted 30 days after they finish.Requires:
automations_readShow fields
Show fields
ArgumentsFields
String
Returns runs after this cursor.
Int
Returns the first N runs (max 100, default 25).
Only runs with one of these statuses.
required
The list of edges (each a node plus its pagination
cursor).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.String!
required
The draft as AutomationScript, Function code inline. To change it, open a workspace with
workspaceCreate.String!
required
The draft’s trigger kind.
required
Which version runs already in flight continue on.
required
Published versions, newest first.Requires:
automations_readShow fields
Show fields
ArgumentsFields
String
Returns versions after this cursor.
Int
Returns the first N versions (max 100, default 25).
required
The list of edges (each a node plus its pagination
cursor).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.ID!
required
The id of this run.
required
Where the run is in its lifecycle.
required
The steps the run executed, in order, with their inputs, outputs and effects.
Show fields
Show fields
String!
required
The step’s kind.
String
A note the step left, such as why it was skipped.
String
completed, disabled, failed or cancelled; null while running.
String
The output port the run left the step by.
String!
required
The step’s id in the automation’s script.
Int!
required
The automation version the run is on. A waiting run that a publish moves to a newer version keeps reporting the old one until it resumes.
Example
mutation {
automationExecute(id: "...", idempotencyKey: "...", payload: "...") {
finishedAt
id
startedAt
status
version
}
}