Changelog and versioning

Versioning

The protocol version is carried in api_version. Compatible fields may be added without a version bump, so ignore unknown JSON fields and key ordering.

Deprecation

Breaking changes are announced with a migration period. WebSocket remains WIP and has no compatibility guarantee until separately released.

Current MVP

The MVP includes registry, credentials, signed retrying webhooks, direct/group contexts, message send/replace, media, buttons, menus, and @echo_bot.

SDK practice

Ignore unknown JSON fields. An unknown event type can be acknowledged with an empty 2xx response and recorded for diagnostics.

Before an SDK major upgrade, read the changelog and test webhook handling, sending, editing, callbacks, and media uploads.

// Ignore unknown fields so additive API changes remain compatible.
const { type, data } = event;
if (type === 'message.created') await handleMessage(data);