---
title: "API changelog entry published event"
method: POST
path: "api.changelog.published"
tags: ["Webhook Events"]
---

# API changelog entry published event

`POST api.changelog.published` (webhook)

Fired when an entry is published to the API changelog (https://docs.zernio.com/changelog), which happens when a change to this OpenAPI spec goes live. The event belongs to no profile or account: every active subscription that opted in receives it, scoped subscriptions (`profileIds` / `accountIds`) do not. `entry.changes` is the deterministic diff of the spec (operations and schemas added, removed and modified); `entry.message` is the written announcement. Act on `changes` and `type`, read `message` for the why. Entries are listed by `GET /v1/changelog`.

## Payload

- WebhookPayloadApiChangelogPublished
  - `id` string, required — Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.
  - `event` 'api.changelog.published', required
  - `entry` ApiChangelogEntry, required — One API changelog entry, as shown on https://docs.zernio.com/changelog.
    - `id` string, required — Stable entry id; the same entry is never published twice.
    - `type` 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor', required
    - `platforms` string[], required — Platform and area slugs the entry is about: a platform (`instagram`, `facebook`, `threads`, `tiktok`, `x`, `linkedin`, `youtube`, `pinterest`, `reddit`, `bluesky`, `telegram`, `snapchat`, `whatsapp`, `discord`, `slack`, `google-business`, `imessage`), an ads platform (`meta-ads`, `google-ads`, `tiktok-ads`, `linkedin-ads`, `pinterest-ads`, `x-ads`) or an area (`ads`, `publishing`, `inbox`, `telephony`, `commerce`, `analytics`, `webhooks`, `general`). Filter with the `platform` query parameter.
    - `message` string, required — The announcement, in Markdown.
    - `publishedAt` string, date-time, required
    - `specVersion` string, nullable, required — The `info.version` of the OpenAPI spec the entry describes, when known.
    - `url` string, uri, required — The entry on the docs changelog.
    - `changes` object, required — Deterministic diff of the OpenAPI spec behind the entry. Empty lists when nothing of that kind changed.
      - `endpoints` object, required
        - `added` ApiChangelogOperationRef[], required
          - `method` string, required
          - `path` string, required
          - `operationId` string
        - `removed` ApiChangelogOperationRef[], required
          - `method` string, required
          - `path` string, required
          - `operationId` string
        - `modified` ApiChangelogOperationRef[], required
          - `method` string, required
          - `path` string, required
          - `operationId` string
      - `schemas` object, required
        - `added` string[], required — Component schema names.
        - `removed` string[], required
        - `modified` string[], required
  - `timestamp` string, date-time, required — UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) · [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/3eea42782f09?raw)