Skip to content

by Startups.Studio

Core grammar Workflow

Workflow.create

POST /{namespace}/workflows

Creates a Workflow.

Noun: Workflow
Mode: do
Event: Workflow.created

You, to your agent

Add a workflow to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/workflows \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'

import { $ } from 'startup-builder'

const workflow = await $.Workflow.create({ steps: {} })

npx startup-builder do Workflow.create --json '{"steps":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Workflow.create({ steps: {} })"
  }
}

Create makes a new Workflow from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`steps`	`json`	required	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.
`process`	Process		A Process does its work through Workflows, each the durable, executable part of the Process.

Outputs

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

Effects

Emits Workflow.created.
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.create

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

Previous Page

Workflow.delete

Next Page