Flow · StartupBuilder

Properties

Property	Type	Required	Description
`persona`	Persona	required	The Persona it guides; its Role decides which Verbs each step offers.
`offer`	Offer	required	The Offer whose activation Event ends the Flow; time to value reads from first step to that Event.
`steps`	list of Dashboard	required	The Dashboards in order, first run first, each ending in the Verb that opens the next.

Object

JSON

{
  "$id": "https://api.sb/petpantry.shop/flows/flow_1",
  "$type": "Flow",
  "persona": "persona_1",
  "offer": "offer_1",
  "steps": [
    "dashboard_1"
  ]
}

Relationships

A Flow has one App: the Flows an App runs on first sign-in, one per Persona and Offer, each ending at the activation Event. app, inverse guides.

Verbs

createCreates a Flow.
POST /{namespace}/flowsdoFlow.created
getReturns one Flow by id.
GET /{namespace}/flows/{id}readNo Event
listReturns Flows, newest first, one page at a time.
GET /{namespace}/flowsreadNo Event
updateChanges the given properties of a Flow.
PATCH /{namespace}/flows/{id}doFlow.updated
deleteDeletes a Flow; its history is kept.
DELETE /{namespace}/flows/{id}doFlow.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Flow.create`	Yes	Yes	Yes	No
`Flow.get`	Yes	Yes	Yes	Yes
`Flow.list`	Yes	Yes	Yes	Yes
`Flow.update`	Yes	Yes	Yes	No
`Flow.delete`	Yes	Yes	Yes	No

Call it

Text

Add a flow to Kiln Bakery with a persona and an offer and a dashboard.

Example

The buyer Flow on stitchly.co has three steps: describe a garment, pick a tailor, pay for the first Order. It ends at Customer.activated, and time to value is measured across those three steps.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link