Announcement Events
Webhook events Everee sends when it publishes, edits or retracts an announcement.
Audience: company or partner. Everee sends a webhook when it publishes, edits or retracts an announcement. INTEGRATION announcements (API releases, deprecations, maintenance and security notices) are sent to both companies that use Everee directly and partners that build Everee into their product. PRODUCT and OPERATIONS announcements (such as service disruptions, bank holidays and state rule changes) are sent to partners only. See How announcements reach you. To read the announcements themselves, see the Announcements API guide.
Events
| Event type | Sent when |
|---|---|
announcement.published | An announcement is published |
announcement.updated | A published announcement is edited. The event carries its current state and may cover several edits made close together |
announcement.retracted | A published announcement is withdrawn. Only owners who received announcement.published receive it |
Who receives them
Everee decides by how you work with Everee.
| You are | You receive them at | Envelope |
|---|---|---|
| A company that uses Everee directly | The company's own webhook endpoints | Company envelope, with companyId |
| A partner that builds Everee into its own product | The partner's partner webhook endpoints, once for the partner and not once per company | Partner 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.
| Field | Type | Meaning |
|---|---|---|
id | integer | The announcement's ID. Use it as the key |
key | string | A stable name for the subject, such as bank-holiday:2026-11-26. It stays the same when an announcement is retracted and published again |
kind | string | INTEGRATION, PRODUCT or OPERATIONS |
category | string | The category, which decides the kind. See Kinds and categories |
severity | string | INFO, IMPORTANT or CRITICAL |
reader | string | PARTNER, or CUSTOMER when it's written so you can show it to your customers as is |
title | string | A headline |
summary | string | A short description |
scope | object | Which companies it applies to: {"type": "ALL"}, or {"type": "STATES", "states": ["CO"]} with two-letter state codes. See Scope |
startsAt, endsAt | date-time | When it applies |
displayUntil | date-time | When to stop showing it |
actionRequired | boolean | true if the reader must act |
actionBy | date | The date to act by |
details | object | Fields specific to the category. See Details by category |
affected | string | The endpoints, versions or features it concerns |
learnMoreUrl | string | Where the full announcement lives |
publishedAt | date-time | When Everee published it, in UTC |
retractedAt | date-time | Only on announcement.retracted: when it was withdrawn |
Ignore fields and details keys you don't know: Everee adds to them over time. See Staying compatible.
Webhook event type: announcement.published (and announcement.updated, announcement.retracted).
Example data.object. The values are made up.
{
"id": 142,
"kind": "INTEGRATION",
"category": "DEPRECATION",
"severity": "IMPORTANT",
"reader": "PARTNER",
"title": "The v1 worker search endpoint is going away",
"summary": "Move to the search parameters on the list workers endpoint before 2027-03-01.",
"scope": { "type": "ALL" },
"actionRequired": true,
"actionBy": "2027-03-01",
"details": {
"sunsetDate": "2027-03-01",
"endpoints": ["GET /integration/v1/workers/search"],
"replacement": "The search parameters on GET /integration/v1/workers"
},
"affected": "GET /integration/v1/workers/search",
"learnMoreUrl": "https://developer.everee.com/docs/worker-search-migration",
"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.
Updated 13 days ago