Skip to content

by Startups.Studio

Core grammar Watch

Watch.update

PATCH /{namespace}/watches/{id}

Changes the given properties of a Watch.

Noun: Watch
Mode: do
Event: Watch.updated

You, to your agent

Change the latest watch.

curl -X PATCH https://api.sb/tutorloop.com/watches/watch_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://tutorloop.com"}'

import { $ } from 'startup-builder'

const watch = await $.Watch.update({ id: 'watch_1', url: 'https://tutorloop.com' })

npx startup-builder do Watch.update --json '{"id":"watch_1","url":"https://tutorloop.com"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Watch.update({ id: 'watch_1', url: 'https://tutorloop.com' })"
  }
}

Update changes the given properties of a Watch. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Watch.
`selector`	`string`		The Event selector, such as `Order.placed`.
`url`	`url`		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.

Outputs

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

Effects

Emits Watch.updated.
Two-way: try, send, do.

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.	Watch.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Watch.rotate

Previous Page

Workflow

Next Page