Webhook Events

API changelog entry published event

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.

postWebhookapi.changelog.published

Payload

idstring 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
timestampstring 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.

Example payload

{
  "entry": {
    "platforms": [
      "whatsapp",
      "inbox"
    ],
    "changes": {
      "endpoints": {
        "added": [
          {
            "method": "POST",
            "path": "/v1/ads/create",
            "operationId": "createAd"
          }
        ],
        "removed": [
          {
            "method": "POST",
            "path": "/v1/ads/create",
            "operationId": "createAd"
          }
        ],
        "modified": [
          {
            "method": "POST",
            "path": "/v1/ads/create",
            "operationId": "createAd"
          }
        ]
      }
    }
  }
}

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.