{"uid":"cap_df__83nhKyu8IEOEl3VU6","slug":"usaref-webhook-alert-registration-b36d7860","name":"usaref Webhook Alert Registration","description":"Authoritative North American government reference values as clean JSON: central-bank policy rates, VAT rates, national minimum wages and public holidays for Canada (ca), United States (us). Every value carries a citation to its official primary source (government gazette or central-bank statement), an effective date, a last-confirmed date and a staleness flag.","url":"https://usaref.dev/alerts","method":"POST","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method","bodyType","body"],"properties":{"body":{"type":"object","required":["url","series"],"properties":{"url":{"type":"string","format":"uri","description":"Webhook endpoint for series.changed events"},"series":{"type":"array","items":{"type":"string"},"description":"Patterns like \"bs/policy-rate\", \"ca/*\", or \"*\""}}},"type":{"type":"string","const":"http"},"method":{"enum":["POST"],"type":"string"},"bodyType":{"enum":["json","form-data","text"],"type":"string"}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object","required":["id","url","series","secret"],"properties":{"id":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"secret":{"type":"string","description":"HMAC-SHA256 signing secret — shown once"},"series":{"type":"array","items":{"type":"string"}},"created":{"type":"string"}}}}}}},"responseSchema":{"type":"json","example":{"id":"3f6a1c2e-0000-4000-8000-000000000000","url":"https://example.com/webhook","active":true,"secret":"hex-encoded-hmac-secret","series":["ca/policy-rate"],"created":"2026-07-15T12:00:00.000Z"}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.1","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.1/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.1","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.1","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_br1EAAaPbe3eJSaahE3f_","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.1","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Registers a webhook endpoint to receive real-time notifications when North American government reference data series (policy rates, VAT rates, minimum wages, public holidays) change","exampleAgentPrompt":"Set up a webhook to https://myapp.example.com/hooks/usaref so I get notified whenever the Canadian policy rate or any US reference data changes — subscribe to both ca/policy-rate and us/*.","exampleUseCases":[{"title":"Monitor Fed policy rate changes","prompt":"Register a webhook at https://alerts.myfintech.io/usaref to ping us whenever the US central bank policy rate changes — subscribe to us/policy-rate so we can update our loan pricing automatically."},{"title":"Track Canadian minimum wage updates","prompt":"Set up a usaref alert to https://hr.mycompany.com/webhooks/gov so we're notified the moment any Canadian minimum wage data changes — use the series pattern ca/minimum-wage."},{"title":"Subscribe to all North American reference data","prompt":"Create a webhook subscription for https://data.myplatform.com/usaref-events that watches all series with the wildcard * pattern, so we catch any change to any government reference value across Canada and the US."}],"resultDescription":"A JSON object confirming the webhook subscription, including a unique subscription ID (UUID), the registered webhook URL, an active boolean flag, a hex-encoded HMAC secret for verifying incoming webhook payloads, the list of subscribed series patterns, and the ISO 8601 creation timestamp.","failureModes":["Invalid or unreachable webhook URL returns validation error","Malformed series pattern strings cause 400 Bad Request","Duplicate subscription for same URL and series may return conflict or duplicate record","Payment failure (insufficient USDC balance) returns 402 Payment Required","Webhook endpoint not publicly accessible leads to silent delivery failures later","Missing required fields returns 422 Unprocessable Entity"],"whenToPreferThis":"Choose this endpoint when you need real-time push notifications for changes to authoritative North American government reference data rather than polling. It is ideal for financial systems, HR platforms, or compliance tools that must react immediately when policy rates, VAT rates, minimum wages, or public holidays change. Prefer this over polling the data series endpoints directly when low-latency change detection and event-driven automation are required.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-13T18:40:52.991Z","isFirstParty":false}