Announcement Events

Webhook events Everee sends when it publishes, edits or retracts a technical announcement.

Audience: company or partner. Everee sends a webhook when it publishes, edits or retracts a technical announcement: an API release, a deprecation, a maintenance notice or a security notice. Product announcements are not sent as webhooks. To read the announcements themselves, see the Announcements API guide.

Events

Event typeSent when
announcement.publishedAn announcement is published
announcement.updatedA published announcement is edited. The event carries its current state and may cover several edits made close together
announcement.retractedA published announcement is withdrawn. Only owners who received announcement.published receive it

Who receives them

Everee decides by how you work with Everee.

You areYou receive them atEnvelope
A company that uses Everee directlyThe company's own webhook endpointsCompany envelope, with companyId
A partner that builds Everee into its own productThe partner's partner webhook endpoints, once for the partner and not once per companyPartner envelope, with partnerId

An owner with no enabled endpoint receives nothing. Sandbox instances receive nothing. Announcement events arrive only for announcements published after Everee switched them on; earlier announcements are available from the API.

Payload

data.object is the announcement without its full text, so the event stays small. Fetch the full text with Get an announcement using id. A retracted announcement is no longer returned by the API, so the retraction event carries enough to say what was withdrawn. Fields without a value are omitted.

FieldTypeMeaning
idintegerThe announcement's ID. Use it as the key
kindstringAlways TECHNICAL
categorystringAPI_RELEASE, DEPRECATION, MAINTENANCE or SECURITY
severitystringINFO, IMPORTANT or CRITICAL
titlestringA headline
summarystringA short description
effectiveDatedateWhen the change takes effect, if there is a date
sunsetDatedateFor a deprecation, when the old behavior stops working
affectedstringThe endpoints, versions or features it concerns
learnMoreUrlstringWhere the full announcement lives
mandatorybooleantrue for security notices and deprecations with a sunsetDate
publishedAtdate-timeWhen Everee published it, in UTC
retractedAtdate-timeOnly on announcement.retracted: when it was withdrawn

Webhook event type: announcement.published (and announcement.updated, announcement.retracted).
Example data.object. The values are made up.

{
  "id": 142,
  "kind": "TECHNICAL",
  "category": "DEPRECATION",
  "severity": "IMPORTANT",
  "title": "Legacy payables endpoint retires",
  "summary": "The v0 payables endpoint stops working on 2027-04-01.",
  "effectiveDate": "2027-01-15",
  "sunsetDate": "2027-04-01",
  "affected": "POST /api/v0/payables",
  "learnMoreUrl": "https://developer.everee.com/changelog/legacy-payables",
  "mandatory": true,
  "publishedAt": "2026-11-02T15:04:05.123456Z"
}

The object is also defined as a JSON Schema.

Handling them

Events can arrive more than once and out of order. Treat id as the key, and treat the latest event for an id as its state. If you receive announcement.retracted for an announcement, remove or mark it. See Implementing a Webhook Handler.


Did this page help you?