automations_write
Arguments
required
The whole definition.
Show fields
Show fields
required
String!
required
The automation’s name.
String
The checker rules to hold it to. Omitted: a saved automation keeps its own, and a new one gets the newest.
required
The steps, at most 500.
Show fields
Show fields
String
A
core.function step’s TypeScript code; only that kind takes it.The kind’s settings, matching the
configJsonSchema of this kind and version in automationKinds.String
A note on the step.
Boolean
Skip the step when the automation runs.
String!
required
The step’s id, unique in the automation.
String!
required
The step kind, such as
core.wait.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas.
String
The step’s name; omitted shows the kind’s title.
required
What starts a run.
Show fields
Show fields
The kind’s settings, matching the
configJsonSchema of this kind and version in automationKinds.String
A note on the trigger.
String!
required
The trigger kind, such as
core.schedule.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas.
Returns
required
An automation built in Developer › Automations: a trigger and the steps it runs. For email and SMS flows, use MarketingAutomation. Agents create and edit one as script in a workspace (
workspaceCreate; read guide/ in automationCatalog first). Apps send typed definitions to automationCreate and automationDraftUpdate.Show fields
Show fields
required
The draft as typed data, Function code inline. To change it, pass a changed copy to
automationDraftUpdate.Show fields
Show fields
required
An expression a run must meet to start; null admits every run. Read
guide/expressions in automationCatalog.String!
required
The automation’s name.
String!
required
The checker rules the automation is held to. A rule added in a later version only warns until you raise it.
required
The steps, in the order the editor lists them.
Show fields
Show fields
String
A
core.function step’s TypeScript code; null for other kinds.The kind’s settings. Their shape is the
configJsonSchema of this kind and version in automationKinds.String
A note on the step.
Boolean!
required
Skipped when the automation runs: the run continues on the step’s default port.
String!
required
The step’s id, unique in the automation. Edges and diagnostics refer to it.
String!
required
The step kind, such as
core.wait.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas; null if never placed.
String
The step’s name; null shows the kind’s title.
required
What starts a run.
Show fields
Show fields
The kind’s settings. Their shape is the
configJsonSchema of this kind and version in automationKinds.String
A note on the trigger.
String!
required
The trigger kind, such as
core.schedule.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas; null if never placed.
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).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
required
The automation this run belongs to.Requires:
automations_readWhy the run failed; null unless
status is FAILED.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.
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.
String
The event type a WAITING run’s await-event step is waiting for; null for a timed wait and for a run that isn’t waiting.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.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).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
required
This version as typed data, Function code inline.
String!
required
This version as AutomationScript, Function code inline. Read
guide/script in automationCatalog for the syntax.String!
required
The trigger this version runs on.
Int!
required
The version number, from 1.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.Example
mutation {
automationCreate(definition: { ... }) {
createdAt
enabled
id
name
publishedVersion
revision
runs {
nodes {
finishedAt
id
startedAt
status
version
waitingOn
}
pageInfo { hasNextPage endCursor }
}
script
# ...
}
}