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

Trigger routes: create, get, list

The Trigger Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Trigger, one group of Trigger routes.

Trigger.create

Creates a Trigger. Verb page.

Text
POST /{namespace}/triggers

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

Inputs

InputTypeRequiredDescription
eventstringThe Event selector it matches, such as Order.placed.
schedulestringA cadence or cron expression.
wherestringThe predicate an event Trigger matches, such as choice = 'raise'.
thresholdjsonA Metric staying below or above a value, optionally for a while, such as four weeks.
atstringWhen in its cadence a schedule runs, on the namespace’s clock, such as mon 09:00.

Returns

OutputTypeRequiredDescription
triggerTriggerrequiredThe Trigger.

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/triggers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"Example event"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "trigger": {
    "$id": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
    "$type": "Trigger",
    "event": "Example event",
    "schedule": "Example schedule"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Trigger.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Trigger.get

Returns one Trigger by id. Verb page.

Text
GET /{namespace}/triggers/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
triggerTriggerrequiredThe Trigger.

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/triggers/trigger_Hg9n0lrBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Trigger",
  "$id": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
  "trigger": {
    "$id": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
    "$type": "Trigger",
    "event": "Example event",
    "schedule": "Example schedule"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
    "up": "https://api.sb/leaseline.app/triggers"
  }
}

Trigger.list

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

Text
GET /{namespace}/triggers

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
triggerslist of TriggerrequiredOne page of Triggers.

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/triggers?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Trigger",
  "triggers": [
    {
      "$id": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
      "$type": "Trigger",
      "event": "Example event",
      "schedule": "Example schedule"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "trigger_Hg9n0lrBdP"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/triggers?limit=20",
    "next": "https://api.sb/leaseline.app/triggers?after=trigger_Hg9n0lrBdP"
  }
}

Trigger

Previous

update, delete

Next