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

Watch routes: create, get, list

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

Reference for Watch, one group of Watch routes.

Watch.create

Creates a Watch. Verb page.

Text
POST /{namespace}/watches

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

Inputs

InputTypeRequiredDescription
selectorstringrequiredThe Event selector, such as Order.placed.
urlurlrequiredWhere deliveries go.
payloadstringOne of full, or thin: the record as the Action left it, or only its versioned address. The default is full.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch.
secretstringrequiredThe signing secret, as whsec_ and 32 characters, shown once: store it beside the receiver.

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/watches \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"selector":"Example selector","url":"https://leaseline.app"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "secret": "whsec_4f9c2a7e1b8d3f6a0c5e9b2d7a4f1c8e",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Watch.get

Returns one Watch by id. Verb page.

Text
GET /{namespace}/watches/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch.

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/watches/watch_9o4vCuR17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Watch",
  "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "up": "https://api.sb/leaseline.app/watches"
  },
  "actions": {
    "pause": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/pause",
    "replay": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/replay",
    "resume": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L/resume"
  }
}

Watch.list

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

Text
GET /{namespace}/watches

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
watcheslist of WatchrequiredOne page of Watches.

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

Watch

Previous

update, delete

Next