Flow programs: create, get, list

Reference for Flow, one group of Flow programs.

Flow.create

Creates a Flow. Verb page.

Text

do: return await $.Flow.create(input)

Emits Flow.created.

Inputs

Input	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.
`app`	App		The Flows an App runs on first sign-in, one per Persona and Offer, each ending at the activation Event.

Returns

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

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.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flow.create({ persona: 'persona_YdpO6wSexq', offer: 'offer_2hzYe1ERo0', steps: ['dashboard_QL9I0ALqO4'] })"
  }
}

Flow.get

Returns one Flow by id. Verb page.

Text

do: return await $.Flow.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Flow.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

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.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flow.get({ id: 'flow_uuJzIzjvrp' })"
  }
}

Flow.list

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

Text

do: return await $.Flow.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`flows`	list of Flow	required	One page of Flows.

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.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flow.list({ limit: 20 })"
  }
}

Flow.createCopy Anchor Link

Flow.getCopy Anchor Link

Flow.listCopy Anchor Link

Flow.create

Flow.get

Flow.list