Watch methods: pause, replay, resume, rotate
The Watch Verbs pause, replay, resume, rotate as typed SDK methods, with inputs, result, refusals and an example.
Reference for Watch, one group of Watch methods.
Watch.pause
Pause stops a Watch delivering while its Events keep queuing; the platform pauses a Watch whose deliveries fail for three days. Verb page.
interface WatchVerbs {
pause(input: WatchPauseInput, options?: SB.CallOptions): SB.Call<Watch>
}Emits Watch.paused.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch to pause. |
reason | text | Why deliveries stop. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The paused 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
import { $ } from 'startup-builder'
const watch = await $.Watch.pause({ watch: 'watch_9o4vCuR17L' })Watch.replay
Replay redelivers a Watch’s Events from a chosen point, signed as they were the first time. Verb page.
interface WatchVerbs {
replay(input: WatchReplayInput, options?: SB.CallOptions): SB.Call<Watch>
}Emits Watch.replayed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch to replay. |
from | datetime | required | Where the replay starts. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch, replaying. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| 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
import { $ } from 'startup-builder'
const watch = await $.Watch.replay({ watch: 'watch_9o4vCuR17L', from: '2026-10-22T12:Watch.resume
Resume restarts a paused Watch and delivers the Events it held, oldest first. Verb page.
interface WatchVerbs {
resume(input: WatchResumeInput, options?: SB.CallOptions): SB.Call<Watch>
}Emits Watch.resumed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The paused Watch. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch, delivering again. |
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
import { $ } from 'startup-builder'
const watch = await $.Watch.resume({ watch: 'watch_9o4vCuR17L' })Watch.rotate
Rotate issues a new signing secret for a Watch and signs with both secrets until the old one expires. Verb page.
interface WatchVerbs {
rotate(input: WatchRotateInput, options?: SB.CallOptions): SB.Call<WatchRotateOutput>
}Emits Watch.rotated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch whose secret changes. |
overlap | string | How long the old secret keeps signing, as an ISO 8601 duration; defaults to PT24H. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
watch | Watch | required | The Watch, signing with both secrets. |
secret | string | required | The new signing secret, shown once. |
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
import { $ } from 'startup-builder'
const { watch, secret } = await $.Watch.rotate({ watch: 'watch_9o4vCuR17L' })