Event programs · StartupBuilder

Reference for Event.

Event.create

Creates an Event. Verb page.

Text

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

Emits Event.created.

Inputs

Input	Type	Required	Description
`name`	`string`	required	The Noun and the event form of its Verb, such as `Order.placed`.
`at`	`datetime`	required	When it happened.
`data`	`json`		The Thing as the Action left it.
`seq`	`integer`		Its position in the namespace, one more than the Event before; any seq is a cursor into the history.
`action`	Action		A completed Action emits its Events, which Triggers, Watches and Metrics read.

Returns

Output	Type	Required	Description
`event`	Event	required	The Event.

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 $.Event.create({ name: 'Leaseline', at: '2026-10-22T12:00:00Z' })"
  }
}

Event.get

Returns one Event by id. Verb page.

Text

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

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`event`	Event	required	The Event.

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 $.Event.get({ id: 'evt_9wPvd8R17L' })"
  }
}

Event.list

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

Text

do: return await $.Event.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
`events`	list of Event	required	One page of Events.

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 $.Event.list({ limit: 20 })"
  }
}

Event.capture

Capture records an Event from a Site, App or API call that no Verb emits, such as a page view or a click. Verb page.

Text

do: return await $.Event.capture(input)

Emits Event.captured.

Inputs

Input	Type	Required	Description
`name`	`string`	required	The Event name, `Noun.pastTense`.
`data`	`json`		The Event’s properties.
`visitor`	Visitor		The Visitor it happened to, when the person is not known.

Returns

Output	Type	Required	Description
`event`	Event	required	The captured Event.

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 $.Event.capture({ name: 'Leaseline' })"
  }
}

Event.createCopy Anchor Link

Event.getCopy Anchor Link

Event.listCopy Anchor Link

Event.captureCopy Anchor Link

Event.create

Event.get

Event.list

Event.capture