6. Notices

Announcements Axiom publishes to your account, for example a backorder you should show your clinics.

Base URL https://api.axiomscript.com. Every request is signed; see Authentication and signing.

GET/noticesLive broadcast notices for your account

Live broadcast notices for your account

GET/api/inbound/{partnerSlug}/notices

Short operational announcements Axiom publishes to you: a SKU going backordered, a holiday changing when orders ship. Render them in your own portal; the list is empty until we publish something, and an empty list is a real answer meaning show nothing.

Scoped to the authenticated caller. You receive notices addressed to you and notices addressed to every partner, in the lane of the key that signed the request: a sandbox key never returns production announcements.

Dedupe and re-render on id and revision rather than on the text, so a corrected typo is the same notice rather than a second banner. Expiry is not an event: enforce endsAt locally and stop showing a notice that has passed it, and treat an HTTP error as "unknown", never as an empty list, or a live backorder notice will disappear from your page.

Parameters

partnerSlugstringpathrequired

The partner's Axiom-issued slug (e.g. acme-health).

Responses

Status	Meaning
200	The notices you should be showing right now.
401	Missing, expired, or invalid HMAC signature / timestamp
423	partner_inactive or tenant_suspended. Your partner account is deactivated or suspended, so no request will be served until it is reinstated.
429	Per-partner rate limit exceeded

Response fields (200)

okbooleanrequired

 

noticesarray of objectrequired

 

notices[].idintegerrequired

 

notices[].revisionintegerrequired

Bumped whenever the notice is edited or withdrawn. Dedupe on (id, revision): the same id with a higher revision is the same announcement corrected, not a new one.

notices[].severitystringrequired

One of: info, warning.

notices[].titlestringrequired

 

notices[].bodystringrequired

 

notices[].startsAtstring (date-time)required

 

notices[].endsAtstring (date-time) | nulloptional

Null means until we withdraw it. Stop rendering at this instant yourself; nothing is pushed when it passes.

Request

GET /api/inbound/acme-health/notices
Host: api.axiomscript.com
X-Axiom-Timestamp: 1767225600
X-Axiom-Signature: sha256=<hex>

Response 200

{
  "ok": true,
  "notices": [
    {
      "id": 31,
      "revision": 1,
      "severity": "warning",
      "title": "EXAMPLE-SKU-1 is backordered",
      "body": "New orders for EXAMPLE-SKU-1 are refused until it is back in stock. Orders already placed are not affected.",
      "startsAt": "2026-10-26T13:00:00.000Z",
      "endsAt": null
    }
  ]
}