Skip to content

by Startups.Studio

Core grammar Watch

Watch.create

POST /{namespace}/watches

Creates a Watch.

Noun: Watch
Mode: do
Event: Watch.created

You, to your agent

Add a watch to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/watches \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"selector":"Example selector","url":"https://shiftnote.app"}'

import { $ } from 'startup-builder'

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

npx startup-builder do Watch.create --json '{"selector":"Example selector","url":"https://shiftnote.app"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Watch.create({ selector: 'Example selector', url: 'https://shiftnote.app' })"
  }
}

Create makes a new Watch from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

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.

Effects

Emits Watch.created.
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.create

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

Previous Page

Watch.delete

Next Page