Monitor methods: update · StartupBuilder

Reference for Monitor, one group of Monitor methods.

Monitor.update

Changes the given properties of a Monitor. Verb page.

TypeScript

interface MonitorVerbs {
  update(input: MonitorUpdateInput, options?: SB.CallOptions): SB.Call<Monitor>
}

Emits Monitor.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Monitor.
`kind`	`string`		`internal` watches the Startup’s own routes and jobs; `outside` watches the world, such as a rival’s price.
`target`	`string`		What it checks: a route, a Domain, a Keyword, a prompt or a page.
`every`	`string`		How often it runs, such as `1m` or `1d`.

Returns

Output	Type	Required	Description
`monitor`	Monitor	required	The Monitor.

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 monitor = await $.Monitor.update({ id: 'monitor_8Ed0ESvvRl', kind: 'internal' })