Watch methods: create, get, list

Reference for Watch, one group of Watch methods.

Watch.create

Creates a Watch. Verb page.

TypeScript

interface WatchVerbs {
  create(input: WatchCreateInput, options?: SB.CallOptions): SB.Call<WatchCreateOutput>
}

Emits Watch.created.

Inputs

Input	Type	Required	Description
`selector`	`string`	required	The Event selector, such as `Order.placed`.
`url`	`url`	required	Where deliveries go.
`payload`	`string`		One of `full`, or `thin`: the record as the Action left it, or only its versioned address. The default is full.

Returns

Output	Type	Required	Description
`watch`	Watch	required	The Watch.
`secret`	`string`	required	The signing secret, as `whsec_` and 32 characters, shown once: store it beside the receiver.

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

TypeScript

import { $ } from 'startup-builder'

const { watch, secret } = await $.Watch.create({ selector: 'Example selector', url: 'https://leaseline.app' })

Returns one Watch by id. Verb page.

TypeScript

interface WatchVerbs {
  get(input: WatchGetInput, options?: SB.CallOptions): SB.Call<Watch>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`watch`	Watch	required	The Watch.

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

TypeScript

import { $ } from 'startup-builder'

const watch = await $.Watch.get({ id: 'watch_9o4vCuR17L' })

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

TypeScript

interface WatchVerbs {
  list(input?: WatchListInput, options?: SB.CallOptions): SB.ListCall<Watch>
}

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
`watches`	list of Watch	required	One page of Watches.

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

TypeScript

import { $ } from 'startup-builder'

const watches = await $.Watch.list({ limit: 20 })