Everee publishes announcements about changes that matter to you: new API releases, deprecations, maintenance and security notices, and updates to the product. The Announcements API lets you read them from code, so you can poll for what's new instead of relying on email alone.
| Endpoint | What it does |
|---|---|
| List announcements | Lists the announcements published for you, newest first, with filters |
| Get an announcement | Returns one announcement with its full text |
You authenticate the same way as every other endpoint: your API token and tenant ID. See Authentication & API tokens. Your API token can read announcements without any extra setup. The endpoints are read-only, and they're served at /integration/v1/announcements.
Which announcements you see
You see the announcements Everee published for you. Announcements are published for the way you work with Everee, so a partner that builds Everee into its own product and a company that uses Everee directly can be sent different ones. You never see an announcement that was written for someone else, a draft, or one Everee has retracted. If Everee retracts an announcement, it disappears from the list.
Everee also emails announcements to the technical contacts on file for you. The API shows the same announcements, so you can use it to check what you may have missed.
Kinds and categories
Every announcement has a kind and a category. The category decides the kind.
| Kind | Category | What it's about |
|---|---|---|
TECHNICAL | API_RELEASE | A new or changed endpoint, field, or behavior |
TECHNICAL | DEPRECATION | Something that is going away. sunsetDate says when |
TECHNICAL | MAINTENANCE | Planned maintenance that may affect your integration |
TECHNICAL | SECURITY | A security notice that needs your attention |
PRODUCT | FEATURE | A new feature |
PRODUCT | DOCUMENTATION | New or updated documentation and workflows |
PRODUCT | OFFERING | A change to Everee's products and offerings |
severity is INFO, IMPORTANT, or CRITICAL. mandatory is true for security notices and for deprecations that have a sunsetDate: they're always emailed, and the people who receive them can't opt out of them.
Reading an announcement
| Field | Meaning |
|---|---|
id | The announcement's ID. Use it to tell whether you've already seen one |
kind, category, severity | What it is and how much it matters |
title, summary | A headline and a short description |
body | The full text, as written. It's plain text with line breaks |
effectiveDate | When the change takes effect, if there is a date |
sunsetDate | For a deprecation, the date the old behavior stops working |
affected | The endpoints, versions, or features it concerns, in the author's words |
learnMoreUrl | Where the full announcement lives |
mandatory | Whether it's one of the notices people can't opt out of |
publishedAt | When Everee published it, in UTC |
Finding what's new
Results are always newest first, by publishedAt. A sort parameter is ignored. Results are paged with page and size; size defaults to 20 and is at most 100.
kindandcategorynarrow the list to one kind or category.sincereturns announcements published at or after a time, in ISO 8601, such as2026-11-01T00:00:00Z. To poll, keep thepublishedAtof the newest announcement you've handled, ask forsincethat time, and skip anyidyou've already handled.sunsetBeforereturns announcements with asunsetDateearlier than a date, such as2027-04-01. Use it to find deprecations that are about to take effect.
Webhooks
Technical announcements are also sent as webhook events, so you can react without polling: announcement.published, announcement.updated when one is edited, and announcement.retracted when one is withdrawn. Companies that use Everee directly receive them at their own webhook endpoints. Partners that build Everee into their product receive them at their partner webhook endpoints. The events carry the announcement without its body; call Get an announcement for the full text. Product announcements aren't sent as webhooks. See Announcement Events.
Sandbox
Sandbox tokens can read announcements too, so you can build and test your polling against the Sandbox. Everee doesn't email announcements to Sandbox instances. See Sandbox & Production.