Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarWorkflow

Workflow routes: create, get, list

The Workflow Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Workflow, one group of Workflow routes.

Workflow.create

Creates a Workflow. Verb page.

Text
POST /{namespace}/workflows

Body, as JSON: the inputs. Emits Workflow.created.

Inputs

InputTypeRequiredDescription
stepsjsonrequiredThe ordered steps, each run by a Function.
retriesintegerHow many times a failed step retries.
bodystringThe Verb whose Action it is the durable body of, such as Order.refund; a Workflow with a body has no Trigger.
processProcessA Process does its work through Workflows, each the durable, executable part of the Process.

Returns

OutputTypeRequiredDescription
workflowWorkflowrequiredThe Workflow.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/workflows \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "workflow": {
    "$id": "https://api.sb/leaseline.app/workflows/workflow_4reEHI1SG4",
    "$type": "Workflow",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Workflow.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Workflow.get

Returns one Workflow by id. Verb page.

Text
GET /{namespace}/workflows/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Workflow.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
workflowWorkflowrequiredThe Workflow.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Workflow",
  "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
  "workflow": {
    "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
    "$type": "Workflow",
    "steps": [
      {
        "do": "Lease.list",
        "where": "endsOn is 60 days away"
      },
      {
        "do": "Lease.notify"
      },
      {
        "do": "Message.create",
        "medium": "email"
      }
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
    "up": "https://api.sb/leaseline.app/workflows"
  }
}

Workflow.list

Returns Workflows, newest first, one page at a time. Verb page.

Text
GET /{namespace}/workflows

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
workflowslist of WorkflowrequiredOne page of Workflows.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/workflows?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Workflow",
  "workflows": [
    {
      "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
      "$type": "Workflow",
      "steps": [
        {
          "do": "Lease.list",
          "where": "endsOn is 60 days away"
        },
        {
          "do": "Lease.notify"
        },
        {
          "do": "Message.create",
          "medium": "email"
        }
      ]
    }
  ],
  "meta": {
    "limit": 20,
    "after": "workflow_2dhYBlEno0"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/workflows?limit=20",
    "next": "https://api.sb/leaseline.app/workflows?after=workflow_2dhYBlEno0"
  }
}

Workflow

Previous

update, delete

Next