Skip to content

by Startups.Studio

Core grammar Watch

Watch.pause

POST /{namespace}/watches/{watch}/pause

Pause stops a Watch delivering while its Events keep queuing; the platform pauses a Watch whose deliveries fail for three days.

Noun: Watch
Mode: do
Event: Watch.paused

You, to your agent

Pause the latest watch.

curl -X POST https://api.sb/routewise.dev/watches/watch_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const watch = await $.Watch.pause({ watch: 'watch_1' })

npx startup-builder do Watch.pause --json '{"watch":"watch_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Watch.pause({ watch: 'watch_1' })"
  }
}

Inputs

Input	Type	Required	Description
`watch`	Watch	required	The Watch to pause.
`reason`	`text`		Why deliveries stop.

Outputs

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

Effects

Emits Watch.paused.
Holds every matching Event in order until the Watch resumes.
Notifies the Reliability Engineer when the platform pauses it.

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.pause

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.list

Previous Page

Watch.replay

Next Page