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

Event routes

Every Event Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Event.

Event.create

Creates an Event. Verb page.

Text
POST /{namespace}/events

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

Inputs

InputTypeRequiredDescription
namestringrequiredThe Noun and the event form of its Verb, such as Order.placed.
atdatetimerequiredWhen it happened.
datajsonThe Thing as the Action left it.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
actionActionA completed Action emits its Events, which Triggers, Watches and Metrics read.

Returns

OutputTypeRequiredDescription
eventEventrequiredThe Event.

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/events \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline","at":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_GR8HraK1o0",
    "$type": "Event",
    "name": "Leaseline",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Event.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Event.get

Returns one Event by id. Verb page.

Text
GET /{namespace}/events/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
eventEventrequiredThe Event.

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/events/evt_9wPvd8R17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Event",
  "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
    "$type": "Event",
    "name": "Invoice.billed",
    "at": "2026-10-01T07:00:00Z"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
    "up": "https://api.sb/leaseline.app/events"
  }
}

Event.list

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

Text
GET /{namespace}/events

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
eventslist of EventrequiredOne page of Events.

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/events?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Event",
  "events": [
    {
      "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
      "$type": "Event",
      "name": "Invoice.billed",
      "at": "2026-10-01T07:00:00Z"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "evt_9wPvd8R17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/events?limit=20",
    "next": "https://api.sb/leaseline.app/events?after=evt_9wPvd8R17L"
  }
}

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
POST /{namespace}/events/capture

Body, as JSON: the inputs. Emits Event.captured.

Inputs

InputTypeRequiredDescription
namestringrequiredThe Event name, Noun.pastTense.
datajsonThe Event’s properties.
visitorVisitorThe Visitor it happened to, when the person is not known.

Returns

OutputTypeRequiredDescription
eventEventrequiredThe captured Event.

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/events/capture \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_GR8HraK1o0",
    "$type": "Event",
    "name": "Leaseline",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Event.capture",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

post, settle

Previous

File

Next