Service notices
GET /announcements is the house feed for software: maintenance windows, incidents, pricing changes and action-required notices about the API. The same publish is pushed as a webhook and, when action is needed, emailed.
When something changes on our side, one record is written and every channel reads it: the bell in your dashboard, this endpoint, the announcement.published webhook, and for notices that need action, an email to every account holding an API key. You never have to watch a status page to learn that a field was renamed or a behaviour corrected.
hproxy.com/api/v1/announcementskeycurl https://hproxy.com/api/v1/announcements -H "X-API-Key: hpx_your_key_here"List live notices
Every published notice addressed to an audience your account belongs to, newest first, at most 50. Accepts any valid key (no scope needed). Poll it once an hour at most: it is not a queue, and nothing is lost by polling less. Branch on kind.
| Parameter | Type | Description |
|---|---|---|
kind | string | INFO, MAINTENANCE, INCIDENT, RELEASE, PRICING or ACTION_REQUIRED. Treat ACTION_REQUIRED as a ticket: an integration has something to change, usually with a date in the body. |
audience | string | ALL, CUSTOMERS, PARTNERS or DEVELOPERS. Every account holding an API key is in DEVELOPERS, so notices about the API always reach you here. |
publishedAt, expiresAt | RFC 3339 | The feed is ordered by publishedAt. An expired notice (a maintenance window that has passed) drops out on its own; expiresAt is null while a notice stands. |
linkHref, linkLabel | string | An optional deep link, relative to hproxy.com or absolute. null when there is nothing more to read. |
unread | boolean | Read state belongs to the account and is set from the dashboard, not from this endpoint. A key-only integration sees true until someone opens the notice there. |
Get pushed instead
Subscribe a webhook to announcement.published and the same publish reaches your endpoint, signed like every other event. The payload carries the id, title, kind and audience; fetch the body from this endpoint if you need it.
Email, for what cannot wait
Notices that need action from you are also emailed to the address on every account that holds an API key, from the same sender as your order confirmations. That is the one channel a quiet integration still receives, so keep the account email one that a person reads.
available flag on GET /products, and order outcomes live on the order itself and its webhooks.Need a hand wiring this up? Email support@hproxy.com. A real person reads every message.