Create Watch
create_watchSubscribe to a legal source and get notified when it changes. Deliver alerts by HMAC-signed webhook or email, triggered only when the source's refresh detects actual updates.
Instructions
Subscribe to a board so a change to that source notifies you. Delivery is by webhook (HMAC-SHA256 signed) or email, fired when the source's existing refresh finds real changes -- nothing is crawled on your behalf and there is no real-time trigger. channel is immutable once set; to change it, delete and recreate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Narrow the alert to one citation instead of a whole source. Three mutually exclusive forms. Hierarchy prefix: `{"title": "21", "part": "314"}`, where every level set must match and `title` is required whenever a narrower level is set. Exact section: `{"actId": "CFR_T21_P314_S314_50"}`, validated at create time and the only form EVERY source accepts, including flat ones. Named source: `{"source": "fdic_fil"}`, accepted on `agency_guidance`, `agency_manuals` and `cfr` only. Omit to watch the whole source. | |
| state | No | Board's state, 2-letter and case-insensitive. For a federal board (USC, eCFR, the Federal Register) pass `federal` or omit entirely; the two are equivalent. Must otherwise match the `state` list_boards returned for this corpusType. | |
| channel | No | webhook | |
| corpusType | Yes | Board's corpus_type (e.g. `state`, `state_regulation`, `federal_register`, `agency_guidance`), matched case-insensitively so `USC` / `CFR` work too. Call list_boards for the authoritative list: this is a growing set, not a fixed enum, and not every corpus is a watchable board. | |
| webhookUrl | No | Required when channel is webhook or both. | |
| webhookAuth | No | Optional outbound credential sent on every delivery, so your gateway can authenticate us with the header it already reads. Independent of `webhookSecret`: set neither, either, or both. Only valid on a webhook or both channel watch. | |
| emailAddress | No | Required when channel is email or both. | |
| webhookSecret | No | Optional signing secret, stored encrypted and never returned. Every delivery then carries `X-Vaquill-Signature: sha256=<hex>`, an HMAC-SHA256 of the raw request body bytes keyed with this secret. Verify over the raw body before parsing JSON, constant-time. |