Service notices

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.

get/api/v1/announcements

Request

  • Base URL: https://hproxy.com
  • URL: https://hproxy.com/api/v1/announcements
  • Auth: API key in header X-API-Key

Query parameters

kindstring

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.

audiencestring

ALL, CUSTOMERS, PARTNERS or DEVELOPERS. Every account holding an API key is in DEVELOPERS, so notices about the API always reach you here.

publishedAt, expiresAtstring

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, linkLabelstring

An optional deep link, relative to hproxy.com or absolute. null when there is nothing more to read.

unreadboolean

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.

Response

Success

object required

Changes

No recorded changes to this operation across all 1 revision of this API.