register_alert
Bind a webhook so the next gazette does not silently stale a value you already paid for. REGISTERING IS FREE. Register: $0 · Delivery after trial: $0.10. First 3 deliveries are free; later deliveries are $0.10 and refunded if the webhook fails to send. HMAC-SHA256 signed. Two watch types on the same call: • series: ["za/vat-registration-threshold", "ke/", ""] → series.changed when the served value or its effective date moves. On usaref those watches are statutory (minimum-wage, income-tax, statutory-interest, sales-tax, public-holidays), not a FRED-macro subscription. • sources: [""] → source.changed when the document BYTES change (old/new sha256 + citing series). Bytes ≠ value. Value changes arrive as series.changed. Unknown URLs refuse free (source_not_fingerprinted). Max 20 series + 20 sources. Required: url. Optional: api_key stored on the subscription to fund deliveries after the trial. This call does not meter that key. Prefer this over polling get_changes if you are a long-running agent. This is retention, not a new data product.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Webhook endpoint that will receive HMAC-SHA256 signed events | |
| series | No | Value watches, e.g. ["za/vat-registration-threshold", "ke/*", "*"] | |
| api_key | No | Optional prepaid key stored on the subscription to fund deliveries after the trial. This call does not meter it. | |
| sources | No | Exact official-source URLs from a series source.url. Unknown URLs are refused free. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present on a free refusal or error; no charge | |
| no_charge | No | ||
| price_usd | No | ||
| disclaimer | No | ||
| how_to_pay | No | ||
| bind_series | No | ||
| explanation | No | ||
| x_next_bind | No | ||
| http_endpoint | No | ||
| payment_required | No | true when the call needs payment; how_to_pay explains x402 or card |