Watch

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/watches/watch_1",
  "$type": "Watch",
  "selector": "Example selector",
  "url": "https://patentpad.com",
  "payload": "full"
}

RelationshipsCopy Anchor Link

• A Watch delivers many Events: a Watch delivers each matching Event to its URL, signed, retried and replayable. delivers, inverse deliveredBy.

VerbsCopy Anchor Link

1. createCreates a Watch.
   POST /{namespace}/watchesdoWatch.created
2. getReturns one Watch by id.
   GET /{namespace}/watches/{id}readNo Event
3. listReturns Watches, newest first, one page at a time.
   GET /{namespace}/watchesreadNo Event
4. updateChanges the given properties of a Watch.
   PATCH /{namespace}/watches/{id}doWatch.updated
5. deleteDeletes a Watch; its history is kept.
   DELETE /{namespace}/watches/{id}doWatch.deleted
6. pausePause stops a Watch delivering while its Events keep queuing; the platform pauses a Watch whose deliveries fail for three days.
   POST /{namespace}/watches/{watch}/pausedoWatch.paused
7. replayReplay redelivers a Watch’s Events from a chosen point, signed as they were the first time.
   POST /{namespace}/watches/{watch}/replaydoWatch.replayed
8. resumeResume restarts a paused Watch and delivers the Events it held, oldest first.
   POST /{namespace}/watches/{watch}/resumedoWatch.resumed
9. rotateRotate issues a new signing secret for a Watch and signs with both secrets until the old one expires.
   POST /{namespace}/watches/{watch}/rotatedoWatch.rotated

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Replay the latest watch.

ExampleCopy Anchor Link

A dental group registers a Watch for Reminder.confirmed Events to https://hooks.brightsmiles.dental/reminders. Each delivery is signed, retried on failure, and replayable after an outage.