Skip to content

by Startups.Studio

Core grammar Event

Event.capture

POST /{namespace}/events/capture

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

Noun: Event
Mode: do
Event: Event.captured

You, to your agent

Capture the latest event.

curl -X POST https://api.sb/tutorloop.com/events/capture \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"TutorLoop"}'

import { $ } from 'startup-builder'

const event = await $.Event.capture({ name: 'TutorLoop' })

npx startup-builder do Event.capture --json '{"name":"TutorLoop"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Event.capture({ name: 'TutorLoop' })"
  }
}

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.

Outputs

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

Effects

Emits Event.captured.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
Every Verb emits its own Event, so the registry is the tracking plan.

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.	Event.capture

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

Event

Previous Page

Event.create

Next Page