Skip to content

by Startups.Studio

Core grammar Workflow

Workflow.update

PATCH /{namespace}/workflows/{id}

Changes the given properties of a Workflow.

Noun: Workflow
Mode: do
Event: Workflow.updated

You, to your agent

Change the latest workflow.

curl -X PATCH https://api.sb/tutorloop.com/workflows/workflow_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'

import { $ } from 'startup-builder'

const workflow = await $.Workflow.update({ id: 'workflow_1', steps: {} })

npx startup-builder do Workflow.update --json '{"id":"workflow_1","steps":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Workflow.update({ id: 'workflow_1', steps: {} })"
  }
}

Update changes the given properties of a Workflow. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Workflow.
`steps`	`json`		The ordered steps, each run by a Function.
`retries`	`integer`		How many times a failed step retries.
`body`	`string`		The Verb whose Action it is the durable body of, such as `Order.refund`; a Workflow with a body has no Trigger.

Outputs

Output	Type	Required	Description
`workflow`	Workflow	required	The Workflow.

Effects

Emits Workflow.updated.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Workflow.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Workflow.list

Previous Page

Shared Verbs

Next Page