Added
GET /api/sessions/{sessionId}/chatslistsphonefor a Baileys privacy-id chat the session can map, and the JavaScript, Python, Go and Java SDK types carry it (#2134). Thanks @juanbracamonte.- Dashboard: an open chat's header has a search button for that chat's stored messages, by text and optionally by day; a day alone jumps to its first loaded message. A hit older than the loaded messages is not scrolled to: the bar asks you to scroll up first (#2129). Thanks @juanbracamonte.
- MCP: every tool is advertised with a
title, the name a client shows: the tool name split into words, or thetitleits descriptor sets (#2098). Thanks @sudipta-prodevs. - MCP:
MCP_MAX_RESULT_BYTES, an opt-in cap for clients that put a whole tool result in the model's context. When set, every result, an error answer included, is one text item, cut at that many bytes with a note of its full size, and none is offloaded as a base64 resource; unset or0, the default, changes nothing (#2100). Thanks @sudipta-prodevs. - Dashboard: a message typed in a chat but not sent is listed on that chat's row, after a
Draft:label, in place of the last message until the chat is opened again (#2125). Thanks @juanbracamonte. - Dashboard:
/nametyped in the chat composer offers the session's templates by name, and Enter or a click puts the chosen one in the message field, to be sent like any other message; a template that still holds a placeholder is not sent until its text is edited (#2123). Thanks @juanbracamonte. - whatsapp-web.js: the
409answered while WhatsApp Web reloads its page carriescodeENGINE_PAGE_RELOADINGandretryAfterSeconds, the interval to ask again at, so a client can tell it from other conflicts and retry (#2139).
Changed
- Baileys:
GET /api/sessions/{sessionId}/chatslistsnameas""for a privacy-id chat that has no name, where it was the id's own digits (see Upgrade notes) (#2134). Thanks @juanbracamonte. - Baileys: a chat's
nameinGET /api/sessions/{sessionId}/chatsis trimmed, and a blank one of a chat not held under a privacy id lists the contact's name or the id's digits, where it was listed as it came (see Upgrade notes). - whatsapp-web.js: block and unblock use the library's own LID handling, so an unblock no longer also removes an entry the same person holds under a second id, such as a phone-keyed block from before the LID migration (see Upgrade notes), and a number WhatsApp holds no privacy id for answers
400. The install-time block patch is retired. - The MCP
MessageListtool lists a media message without its payload unless the call setsinlineMedia: true, where it carried the base64 inline up to the 8 MiB budget, so one photo made the result larger than an MCP client takes. - Dashboard: a document in a chat shows as a card with its file name, its size where known and a PDF mark, and a click still downloads it; one left out of the message list showed only
Media(#2105). Thanks @mbdali. - Dashboard: the message field of a chat is multi-line and grows with its draft: Enter sends, Shift+Enter breaks the line (#2123). Thanks @juanbracamonte.
- The amd64 image's Chrome for Testing 157.0.8103.78 to 158.0.8127.36, picking up the browser security fixes released since; the arm64 image keeps the chromium package Debian ships.
- The SSRF guard also refuses the documentation and benchmarking address ranges and the 6a44 relay anycast address
192.88.99.2in webhook, media, plugin download and plugin request urls (see Upgrade notes). - The local media store (
STORAGE_LOCAL_PATH,./data/mediaby default) is owner-only: its root is set0700at every boot when the gateway owns it, and a warning is logged when it does not; new directories and files are written0700and0600, as the databases and the engine auth directories already are (see Upgrade notes). - The storage export archive is written
0600in a0700data/exports, where it was0644in0755, so it is as private as the media it copies; the next boot closes the directory of an archive an earlier version left. - whatsapp-web.js: the
409answered while WhatsApp Web reloads its page says to retry every few seconds for up to a few minutes, where it said to retry in a few seconds (#2139).
Fixed
- Dashboard: an unnamed chat WhatsApp holds under a privacy id is titled by its phone number, in the list and in the header, where both showed the privacy id's own digits (#2134). Thanks @juanbracamonte.
- Dashboard: the chat search and the webhook chat filter find a chat by its number typed with spaces, a plus sign or parentheses, and an unnamed privacy-id chat by the phone that titles it; the filter's chip and suggestions call that chat by it (#2134). Thanks @juanbracamonte.
- Dashboard: opening a chat with a mouse click on its row, or from the New chat panel, puts focus in the message field, where typing first needed a click on it; a tap, or a row selected with the keyboard, does not move focus (#2124). Thanks @juanbracamonte.
- Dashboard: starting an audio or video message pauses the one already playing, where both kept playing at once (#2106). Thanks @mbdali.
- Baileys:
POST /api/sessions/{sessionId}/chats/readsets the chat'sunreadCountback to0when the receipt names the chat's newest received message, and undoes an unread mark set by hand (chats/unreador on the phone) on every record of the chat, also when a message received after the mark put its count in its place; the count and the mark used to stay, so the dashboard's unread badge came back on every reload (#2109). Thanks @juanbracamonte. - Dashboard: a shared contact shows as a card with its name and phone, in the thread, the chat list and a quoted reply, where the raw
BEGIN:VCARDtext was printed (#2110). Thanks @juanbracamonte. - whatsapp-web.js: a message that shares several contacts had an empty
body; it now holds their vCards, newline-joined as on Baileys. The chat list preview and a quote of such a message carry them too. - whatsapp-web.js: block asks WhatsApp for a number's privacy id when the page holds none, so a number the session never talked to can be blocked.
- Baileys: a contact's encrypted edit, encrypted reaction, pin, keep-in-chat toggle, album header, event RSVP, encrypted comment or lone fast-ratchet sender-key distribution no longer lists the chat as unread on its own, lists no chat the session holds no record of, and no longer brings back a chat WhatsApp deleted; the engine counts each as a received message. Two or more of them for one chat that reach the socket in one batch, as after a reconnect, are recognised the same way when no message of its own came in that batch.
- Baileys: such a message merged into a history chunk that counts only that message no longer dates a chat that has a time of its own or brings back a deleted one, and a chat the session holds no other time for is listed at the time the phone gave it; the count it adds stays in the chunk, and a chunk that counts more is left as before.
- Baileys: a message whose decrypted parts include a fast-ratchet sender-key distribution is typed and announced by its content, and its media is downloaded, its buttons clicked and its text quoted as for any other message; a history sync skips such a distribution when it stands alone, where either reached consumers as an
unknownmessage. - Baileys: a history sync's chat title that is only a privacy id no longer replaces the saved, verified or push name a contact holds, so
GET /api/sessions/{sessionId}/contactsand the chat list keep the name. - Baileys: encrypted edits and reactions of one message are applied in the order they arrived, where the older one could end as the final text or emoji after an offline replay on PostgreSQL.
- Baileys: a pin, mute, archive, read mark or timer change synced under the other spelling (lid or phone) of a chat shows on its row instead of a second row at the epoch.
- Baileys: a lid-keyed chat with a pinned, muted or archived state no longer lists a second row under its phone.
- Baileys: a contact whose only name is its privacy id's digits no longer reports them as its push name or saved name in contact reads, the contact list or a status's poster name.
- whatsapp-web.js:
POST /api/sessions/{sessionId}/messages/send-stickeranswers400for a video ffmpeg refuses and503when the host ffmpeg is missing or cannot run, where both were a500that counted toward the session send breaker and kept theIdempotency-Key. - whatsapp-web.js:
GET /api/sessions/{sessionId}/groups/join-infoanswers501on a WhatsApp Web build with no invite preview job, where every code, valid ones included, was the404of an unknown invite. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js: deleting a channel or unsubscribing from one on a page that has not installed the library helpers answers the retryable
409, where it was a bare500. - Baileys: a reaction, edit, delete or poll vote no longer keeps about 1 KB of memory until the account is unlinked.
- Answer
503, not500, when the database drops the row read a stop, delete, logout or force-kill makes, the write that records a stop or delete, or the check a stop record makes after a missed write; nothing was stopped, deleted, logged out or killed. - Log that another node holds a session only when a live peer does, not on every start or delete of a missing session.
- whatsapp-web.js: a send, reply, forward or status post that a page reload cuts while it runs answers a
409that says it may or may not have gone out, where it was a bare500that counted toward the session send breaker; a keyed send keeps itsIdempotency-Key. - Baileys: a media send or product send that fails before the message reaches WhatsApp (the media host refusing the upload, a failed catalog lookup) frees its pacing admission and no longer counts toward the send breaker, and a media send also frees its
Idempotency-Key. - Baileys: a connect, reconnect or session start no longer leaves a key cache and its ten-minute timer running for the life of the process.
- Baileys: a group's second and later settings changes, the lid to phone pairs of a history sync and every answer to an event that the library buffers in one window are delivered, through a new install-time patch,
scripts/patch-baileys-event-buffer.js. - Baileys: a link preview built from a fetched page cuts its title to 256 and its description to 1024 characters, as a supplied preview is held to, where a page could put hundreds of thousands into the message.
- Plugins: an install or an update answers
400naming the field for a manifest whoseingressis not a list, whose hmac-sha256contentTemplateis not a string or whoseheaderortimestampHeader(hmac-sha256 and shared-secret routes),dedupHeaderorconversationId.headeris not a string, where an update stopped the running plugin first and every delivery failed after it loaded; the boot scan refuses the same manifests. - Plugins:
ctx.storageno longer reads or deletes the plugin's ownmanifest.jsonorpackage.jsonthrough the keys./manifest,./packageor a spelling the filesystem folds to them, which made the plugin stop loading at the next boot. - Plugins: a reinstall into the surviving plugin directory that fails after an entry replaced a stored file puts that file back, where the rollback deleted it.
- Plugins: the boot scan no longer renames or deletes a dot-directory such as
.cache.bakor.tmp.newin the plugins directory unless it holds that plugin's package, where it treated it as an interrupted update's leftover. - Plugins: the boot scan logs a warning when a plugin directory is a symbolic link, which it does not follow, where it skipped it without a line in the log.
- MCP: a tool's
sessionIdtakes letters, digits and hyphens, at most 128 characters, as the REST routes do, where any non-empty string reached the lookup. - Webhooks: the OpenAPI schema and the Python and JavaScript SDK types of the update request declare that a
nullsecretclears it, as the route has always accepted. - Dashboard: a whatsapp-web.js chat whose stored-message read is refused for a reason that may pass (no answer, a timeout, a limit, the gateway down) shows a failed load, which loads again when the chat is opened again or the window is focused, where it showed the engine history alone as the whole thread until a reconnect.
- Dashboard: after a failed refresh of a loaded thread, the strip is a button that refreshes the newest page, where the retry it offered fetched an older page, which ended the failure and left the messages of the gap missing.
- Dashboard: a chat is read once its thread has shown, where opening it sent the read at once: while the thread loads or after it fails the chat stays unread, its badge comes back when the thread fails or the chat is left before it showed, and the read goes out when the thread loads.
- Dashboard: the Message Tester keeps a gap between a result label and a value that wraps.
- Dashboard: the Number Checker names the WhatsApp Web page reload when a stopped run carries
ENGINE_PAGE_RELOADING, where it said the session is not connected. - Dashboard: the webhook form counts a chat id entry over 128 characters as incomplete and says so, where Save sent it and the gateway answered a bare
400, and a webhook stored with one could not be saved. - Dashboard: a long group name or an unbroken token in a failed send no longer widens the Message Tester past a phone screen, and a long plugin name ends with an ellipsis on a plugin card.
- Dashboard: the error row of a session card keeps the start of the message in Arabic and Hebrew, where the end was kept and the start cut.
- Dashboard: the plugin instance, webhook secret, template name, API key, Number Checker and BullMQ URL copy buttons show a failure toast when neither clipboard path works, as the chat id button does, where they did nothing.
- Dashboard: the pairing QR image has an alt text in the page language, where it read "QR" in English.
- whatsapp-web.js: a start no longer waits on a
psor a stale lock removal that never returns, such as one stuck on a hung volume; each gets five seconds. - whatsapp-web.js: the onboarding fallback moves a session to
action_requiredon the click that follows five clicks which left the modal in place, where a flow of five screens that each landed tripped it on the fifth. - whatsapp-web.js: the chats of a label carry
lastMessage, as the chat list does. - whatsapp-web.js: a group invite join that a reload cut answers the
503that says it may or may not have been applied, whatever text the failure carries, where a failure with another text answered the400of an invalid invite code. - whatsapp-web.js: a reply or forward whose chat read a page reload cut answers the retryable
409, once the page has kept reloading past its grace, where it answered a500that counted toward the send breaker and kept theIdempotency-Key. - The startup line for missing install-time patches gives a command for each patch and offers a reinstall only for an install that ran with
--ignore-scripts. - Drop the restriction, error, presence and claim state of sessions an infra data import removes, so the restricted-sessions gauge stops counting them and no false lost-claim warning follows.
backup.shandrestore.shread aPLUGINS_DIRexported empty as the app does, as unset to its default directory, where they took the directory./.envnamed.- Baileys: a poll vote on the account's own broadcast-list poll is reported only when it arrives in a 1:1 chat, as documented; a vote from a group, the list or the status chat was reported too.
- Baileys: with
STORE_EPHEMERAL_MESSAGES=false, a message received in a disappearing chat leaves no copy inbaileys_stored_messagesand no text as the chat'slastMessage, and its media is not downloaded, where its content stayed in the database, in backups and in the chat list (see Upgrade notes). - Overlapping updates of one privacy id's phone mapping are written in the order they were made; the older one could land last and stay in
lid_mappings, on a PostgreSQL pool or when both were made in the same turn. - The in-memory privacy id mapping reloaded after a data import skips an id whose write is still under way, where it could keep answering the phone that write cleared or replaced.
- An id whose re-map is being written answers no phone until the write lands, also after its cache entry was evicted or the mapping reloaded, and after a failed re-map until the id is reported again, a negative clears its row (not for an id whose failure was forgotten, see below) or the mapping reloads or the gateway restarts, where it answered the phone the write replaces.
- More failed writes than
LID_MAPPING_CACHE_MAX, which also bounds the failed-write marks, make the oldest forgotten: that id, and a small share of the others (0.5 percent after 5000 forgotten), answer no phone while they have no cache entry, until each is reported again or the mapping reloads or the gateway restarts, and a negative does not end it; a warning names the bound. A forgotten id that is reported again answers its row again; past the same bound of such ids the oldest, once it has no cache entry, answers no phone again until it is reported again, the mapping reloads or the gateway restarts. - A display lookup whose write failed refuses only a row that names another phone than its own, until the same events end it, so a repeated lookup of the stored phone no longer hides the id; another gateway's later report of the id does not end the refusal.
- While the database cannot be read, the readers that answer from the in-memory mapping judge its entry as they judge a stored row, so an id with a failed write no longer answers the phone the write replaces.
- whatsapp-web.js: the writes that are safe to repeat (contact, profile, channel, group setting, label and message reaction, edit, delete, star, pin and vote, status delete), and the reads of channels, labels, message reactions, receipts and history, a group's invite code and join requests and a chat's labels, answer
503when WhatsApp Web does not answer within the protocol timeout, where they answered500; sends, status posts and the other writes keep their answer, except for a timeout in the group lookup and in the check for the invitation sender made before a group write, which answers503as nothing has been applied. - whatsapp-web.js:
message.ackis no longer announced for an entry the account sent of a kind the gateway does not list, with no text or media; it has nomessage.sent. - whatsapp-web.js:
DELETE /api/sessions/{sessionId}/groups/{groupId}/picturesends the delete to WhatsApp itself and answers by WhatsApp's status:200also for a group with no picture left, so a repeat converges, and a retryable503for a rate limit, a timeout or a server error. All three answered403naming missing admin rights, and a picture WhatsApp Web had not loaded was not deleted. A WhatsApp Web build with no job to remove a group picture answers501. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - A media
urlthat carries a user name or password is refused with400on every route that fetches one, where it answered500, counted toward the send breaker and held theIdempotency-Key;send-bulkrefuses a batch holding one at creation, where it accepted the batch and failed the item. - A plugin install
url,PLUGIN_CATALOG_URLor webhookurlthat carries a user name or password fails withURL must not contain credentials (userinfo), where the answer or the stored delivery failure repeated the URL, credentials included. - A media, plugin install, plugin catalog or webhook
urlwith a user name or password that cannot be parsed (a bad port or host) is refused with the same text, where the log line of the refusal and a stored delivery failure named the URL, credentials included. PUT /api/auth/api-keys/{id}withrole: nullon the only admin key no longer answers409when the update changes no role.- Dashboard: the Revoke and Delete confirmation of an API key shows a name that holds
{{name}}as it was typed, where the name came back inside itself, and the Key column shows the(master key)marker of a bootstrap key without the****mask. - The status posts and the profile and group picture routes answer
400, not500, for a mediaurlthat resolves to an internal address, does not resolve or redirects. - Webhook events for messages whose id the engine could not read (an empty id on whatsapp-web.js) each get their own
X-OpenWA-Idempotency-Keyand outbox record, where they shared one, so a receiver that deduplicates on the key kept only the first. scripts/restore.shrefuses an archive that holds the SQLite data store whileDATABASE_TYPEispostgres, before it writes anything; it wrote the file to a path named after the database, where the app never reads it, and answeredRestore complete(see Upgrade notes).- A failed
PUT /api/infra/configwrite answers with the overlay path relative to the working directory and the error code, where it carried the filesystem error that named the host data directory; the full error is in the server log. PUT /api/infra/configanswers400for adatabase.poolSizeabove 9007199254740991, where an environment-pinned pool size let a value such as 1e21 be saved as1e+21, which the next boot refuses.- whatsapp-web.js:
POST /api/sessions/{sessionId}/groups/{groupId}/invite-code/revokeasks the job that resets an invite code where the current WhatsApp Web build keeps it, and answers501on a build with none, where it answered500and the link was not rotated. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js:
GET /api/sessions/{sessionId}/groups/{groupId}/invite-codeanswers501on a WhatsApp Web build that has no job to read the code, and403when WhatsApp gives no code, where it answered a bare500. - whatsapp-web.js:
PUT /api/sessions/{sessionId}/profile/statusanswers501on a WhatsApp Web build that no longer has the call the library uses to set the About text, where it answered500. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js:
POST /api/sessions/{sessionId}/messages/pinand/messages/unpincall the page's pin sender the way the WhatsApp Web build takes it, where they answered a bare500on every build from 2.3000.1052565782 on; a build with no sender the adapter can call answers501. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js:
POST /api/sessions/{sessionId}/groups/joinanswers501on a WhatsApp Web build with no group join job, where it answered400for every code; a group that has an admin approve new members says a request to join was sent, where it said the invite was invalid. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js: the group subject, description, picture, announce, locked and member add mode writes and
PUT /api/sessions/{sessionId}/profile/pictureanswer501on a WhatsApp Web build with no job to send them, and the retryable409on a page whatsapp-web.js has not installed its helpers into, where they answered a bare500. - whatsapp-web.js: adding participants no longer fails as a whole with
500on a WhatsApp Web build where the library's invite sender moved; a participant who can only be invited is a403of its own, no invitation is sent there, and the others keep their outcome. - whatsapp-web.js: a read, a write that is safe to repeat, the invite code revoke and the check made before adding participants answer the retryable
409when they reach a document WhatsApp Web has not booted yet, where they answered500, or404for a group, contact or label lookup. - whatsapp-web.js: the group subject, description, picture, announce, locked and member add mode writes, the account's profile picture, the invite revoke and the invite code read answer
503for a rate limit, a timeout or a server error from WhatsApp and403for a refusal, where every status answered403naming missing admin rights; a refused announce or locked write answered200, and an account that may not set them a bare500. - whatsapp-web.js:
DELETE /api/sessions/{sessionId}/profile/pictureanswers the retryable503when WhatsApp rate-limits, times out or fails the removal (408, 423, 429 or 5xx), where it answered403, and501on a WhatsApp Web build with no job to send it. A page reload that lands on the call answers the retryable409withcodeENGINE_PAGE_RELOADING. - whatsapp-web.js:
POST /api/sessions/{sessionId}/chats/muteanswers400for a channel id, which is muted through its own route, where the mute and the unmute answered a bare500. - whatsapp-web.js:
DELETE /api/sessions/{sessionId}/profile/picturesends the removal whatever WhatsApp Web's copy of the picture holds, so a repeat answers what WhatsApp answers and no longer a local200; WhatsApp's answer for an account with no picture has not been observed. - whatsapp-web.js:
POST /api/sessions/{sessionId}/channels/{channelId}/delete,POST /api/sessions/{sessionId}/channels/{channelId}/muteandDELETE /api/sessions/{sessionId}/channels/{channelId}answer a503that says the operation may or may not have been applied when WhatsApp reports a timeout, a rate limit or a server error (408, 423, 429 or 5xx), where they answered403or, for an error of the query itself, a bare500; a suspended channel (423) and an answer of the query that holds nothing (a 500 the page's own job makes up) stay403. - whatsapp-web.js:
POST /api/sessions/{sessionId}/groups/joinandGET /api/sessions/{sessionId}/groups/join-infoanswer the retryable503when WhatsApp rate-limits, times out or fails the request (408, 423, 429 or 5xx), where a good invite code was answered400or404; a preview that gets neither a group nor an error back from WhatsApp still answers404. - whatsapp-web.js:
POST /api/sessions/{sessionId}/messages/pinand/messages/unpinanswer403for a chat with a contact the account blocked, and by its status (503for 408, 423, 429 or 5xx) when WhatsApp fails the read of the group in front of the send, where both were a bare500. - A request body value that is an object with its own
toString(JSON{"toString":"x"}, a form key such asname[toString]=x) answers400on every route that takes a body, where it answered500and logged a stack. - Deleting a session no longer logs that another node took it, and no longer leaves a stop mark behind for the deleted id, when the heartbeat ticks between the removal of the row and the end of the credential purge.
- The second of two overlapping
DELETE /api/sessions/{sessionId}requests answers404when the first one removed the session, where it answered409that the session was no longer owned by this node. - Starts, deletes and stops of one session that reach a node together, however many, answer
409"running on another node" only when another node holds the session; a delete is no longer left undone and a duplicate start answers400as documented. - A delete or a start of a session that overlaps a stop, logout, force-kill or failed start of it, or two other requests for it, no longer answers
409"no longer owned by this node" or is refused as stopped while no other node holds the session. - A node that takes a session over from a node whose lease lapsed fails the dead node's unfinished bulk batches even when two requests for the session overlapped, where they stayed
pendingorprocessinguntil the node restarted. - A media conversion and a bulk item whose
urlthe SSRF guard refuses leave the reason in the server log, as a send does; the log had no line for either. - Creating, changing and deleting a webhook write
webhook_created,webhook_updatedandwebhook_deletedaudit rows with the key, the session, the URL host, the events and theactiveflag, and the previous host when the URL changed, never the secret, headers or URL path and query; they wrote none. - Retention prunes (webhook outbox, delivery failures, integration dedup log and dead letters, audit log, send idempotency keys, messages) remove a backlog 500 rows at a time, with a pause between statements on SQLite, where one statement held the whole process for as long as it ran (about 2 s for 400,000 outbox rows) and, on PostgreSQL, one past
statement_timeoutwas cancelled on every run. - An acknowledged ingress delivery whose queue job Redis loses (a restore from an earlier snapshot, a failover to a replica that was behind, a restart without persistence) is replayed from its event row, which keeps its payload until the delivery settles; the job was its only copy and the delivery was dropped (see Upgrade notes).
- Sandboxed plugins: a loop that never yields no longer stalls the gateway or grows its memory when it logs on each pass or calls a capability without awaiting it; the worker sends at most 198
ctx.loggerlines per 10 s, has at most 64 capability calls unanswered and holds up to 10000 further calls until a reply frees a slot, refusing the next with a thrownError, and a send still held after the hook handler that made it has returned is refused; it also tells the host about a webhook route once. - Plugin config: saving a list of rows with a secret column that removes one row and adds another no longer gives the new row the stored secret of a kept row (see Upgrade notes).
- Plugin config: a save of a list of rows with a secret column keeps each stored secret on at most one row, and, in a save in which a row moved, never on a row with other fields than its stored row, where rows that differ only by their secret, a row whose secret was cleared or typed over, or a row renamed to another row's fields could take another row's secret.
- Plugin storage: a
ctx.storagekey that holds a lone UTF-16 surrogate (half of an emoji left byslice) is refused, where every such key at one place named the same file (see Upgrade notes). - Plugins: an update to a package whose ingress declaration the host refuses (an unsigned route with
ALLOW_UNSIGNED_INGRESSoff, an unsupportedsdkVersionmajor, a missingwebhook:ingresspermission) is answered400before the running plugin is stopped, where it ranonDisable, unloaded the plugin and rolled back; an install is refused before anything is written. scripts/backup.shandscripts/restore.shread an environment value of only blanks as unset, as the app does; aDATABASE_TYPEof spaces no longer makes the backup of a PostgreSQL install archive its old SQLite file.- Under the bundled compose files,
scripts/restore.shrefuses a plugin-state path from the archive's.env.generatedoutside the data directory, as documented since 0.26.0, wherePLUGIN_STATE_DIRforwarded empty skipped the refusal. - Declare the
automationandmediatags inopenapi.json, so the API explorer describes both groups. - Publish the integer request fields of the session config, automation rule, webhook, webhook redrive, group settings, label and infrastructure config (
database.poolSize, also asGET /api/infra/configreturns it) routes asintegerinopenapi.json; they saidnumberalthough the routes refuse a fraction. - Dashboard: a message search hit on a shared contact shows its name and phone, where it listed the raw
BEGIN:VCARDlines. - Dashboard: text fields, selects and textareas draw a border at 3:1 contrast in the light and dark themes, where it was the 1.2:1 card hairline.
- Dashboard: a focused field draws a 1px ring in the focus colour beside its border, and a hovered select draws that colour, where hover was fainter than the border at rest in the light theme.
- Dashboard: the config field of a plugin instance resizes downwards only, where dragging it sideways pushed it out of its dialog.
- Stop the dashboard's language list announcing itself as a menu to screen readers: it is a plain list of buttons that marks the language in use as current.
- Let the dashboard's tab rows (Number Checker, QR pairing, plugin install and configuration, chat sidebar, group info) take the arrow keys, Home and End, with the selected tab as the row's one Tab stop.
- Say that the search or status filter emptied the dashboard's Sessions list instead of telling the operator, a viewer included, to create a session.
- Underline the documentation link on the dashboard's sign-in card at rest, as its colour alone does not set it apart from the sentence.
- Show the dashboard's empty Sessions Overview message on one centred line instead of wrapping it inside the first table column.
- Mark
event.responseand thecall.accepted,call.rejectedandcall.missedwebhook events as Baileys only in the dashboard's event list, as they never fire on whatsapp-web.js. - Warn in the dashboard's Revoke and Delete confirmations of an API key that the dashboard is signed in with that key and the action signs the operator out.
- Dashboard: picking an emoji, pressing Escape on one, removing a staged file, closing the reply banner and starting a reply from a message menu put focus back in the message field (not after a tap, which would raise a phone's keyboard), where it fell to the page and what was typed next went nowhere.
- Dashboard: the emoji button of the message field tells screen readers whether its panel is open.
- Dashboard: Show more in the sidebar message search keeps the hits already listed and adds the next page under them, where it replaced the list with a loading line and took the reader back to the first hit.
- Dashboard: typing in the sidebar message search shows the loading line at once, where the hits of the text before stayed listed and clickable until the new search started.
- Dashboard: in forced-colors mode (a Windows contrast theme) the focused search box and composer, the selected tab, row and toggle, the custom switches and the filled buttons stay visible, where they were drawn like their peers or not at all.
- Dashboard: the box that shows a new API key and the one in the webhook delete dialog draw their fill, where a style read an undefined property and left them bare.
- Dashboard: the sign-in language select draws one focus frame under keyboard focus, where its box and the select each drew one.
- Dashboard: the warning icon of the note shown when the dashboard is signed in with the key being edited is 4.9:1 on its tint in the light theme, where it was 2:1.
- Dashboard: the Hebrew locale writes the term Session in Latin script throughout, where some values spelled it in Hebrew script.
- Dashboard: the current page of the Logs pager and the open template of the Templates list are marked for screen readers, where only a style told them apart.
- Dashboard: in Arabic and Hebrew, text a person or a plugin author wrote (names, template bodies and previews, found messages, plugin descriptions) and every text field read in their own direction, except the JSON configuration of a plugin instance, which reads left to right as code does, where a Latin sentence showed its full stop on the wrong end and an Arabic preview read its clauses in the wrong order.
- Dashboard: the Infrastructure switches keep their full width beside a long description, so the knob of an on switch stays inside its track at 1100 to 1920px.
- Dashboard: in Arabic and Hebrew, the chat id in the save-contact dialog and in the webhook chat filter reads
15550001111@c.us, notc.us@15550001111, and the@g.us,@c.usand@lidsuffixes in the API key chat hints and the save-contact hint read as they are typed, notg.us@. - Dashboard: the audit log table fits a window from about 1100px, where its Severity column was cut off below about 1340px, and a long session, key or address ends in an ellipsis instead of overprinting the next column.
- Dashboard: the API keys table keeps its row actions in view at any width, where they were cut off on windows up to about 1480px wide (about 1540px for a key with limits in German); its cells take less padding so it fits from about 1440px, and below that the columns beside the actions scroll into view.
- Dashboard: a sidebar label or the brand name that the browser's text size makes too long ends in an ellipsis at its own end (a label also carries its text in a title), where the row cut it mid-letter from about 120% text size in Spanish, French and Portuguese and from about 150% in English, and the brand name lost its start in Arabic and Hebrew.
- PHP SDK: an empty request body is sent as
{}instead of[], which the gateway refused with400on config, proxy, webhook and template updates. - Java SDK: an API error with a JSON body can be Java-serialized, where it threw
NotSerializableExceptionfor the Gson body. - PHP SDK: the
mentions, polloptions, statusrecipients, webhookeventsandfilters, webhook redriveidsand mark-readmessageIdslists are sent as JSON arrays when their keys have gaps (array_filter,array_unique), which the gateway refused with400. - Python SDK: the call link
startTimeis typedint, as the gateway refuses a fraction with400; the PHP docblock and the Go, Java and JavaScript field comments say a whole number. - Python SDK: the source distribution ships
tests/conftest.py, so the tests run from the unpacked archive. - whatsapp-web.js: a send or forward that met a page reload after its first attempt had run answers a
409that says the message may or may not have been sent, where it said to retry; a forward refused there keeps its send pacing admission, as it keeps itsIdempotency-Key. - whatsapp-web.js: a session promoted to
readyafter itsreadyevent was missed no longer answers the page reload409for up to a minute when WhatsApp Web had navigated while it authenticated; the promotion closes the window the probe has just found the helpers through, unless another navigation landed meanwhile (#2139). - Webhooks: a recovery pass that does not fill its batch starts again at the oldest stale delivery, so one whose queue job was lost is replayed while newer stale deliveries keep arriving, where it waited for that backlog to clear.
- Webhooks: a stranded delivery whose stored payload cannot be read (an imported or hand-edited row on SQLite) stays out of the recovery pass for an hour, where the pass read its page again and logged the row on every pass.
- MCP: a tool error carries
retryAfterSecondsbeside itscodewhen the REST answer has one (ENGINE_PAGE_RELOADING,SEND_PACING_LIMITED), where only the code came through. - Baileys: a send, status post, status delete, reaction, edit, message delete or pin whose connection was replaced or stopped while it was being written answers a
409that says it may or may not have been sent, published, removed or applied, where it said the session was not connected.
Documentation
- Say in the OpenAPI
ErrorResponse.codedescription thatPOST /api/infra/restartanswers409withRESTART_DATABASE_NOT_STARTEDorRESTART_ALREADY_RUNNING. - Say in the OpenAPI document, the engine interface and the five clients that
ChatSummary.phoneis Baileys only: whatsapp-web.js lists none and lists an unnamed privacy-id chat under its id. - Say in the
engineLoadeddescription of the session response thatstopstill answers200and records the stop while no engine is loaded, wherelogoutandforce-killanswer400. - Say in the API reference and the OpenAPI text of the routes that reach an engine that a send whose first attempt had already run answers a
409with nocode, which says the message may or may not have been sent, where they called every such409a refusal before WhatsApp that is safe to retry. - Say in the
limitdescription of the MCP tools that answer a bare list (SessionFindAll,SessionGetChats,ContactFindAll,GroupFindAll,WebhooksList) that a call returns at most 1000 rows, also whenlimitis omitted, so a full page may not be the whole list. - Correct the 0.27.0 rollback hazard in the migration guide: run
migration:revert:produntilmigration:show:prodlistsAddChatStateDeletedAt1791700000000as pending; it said once, which since 0.28.0 only drops the status media index. - Say in the docs that
INGRESS_DISPATCH_TIMEOUT_MS,SANDBOX_HOOK_TIMEOUT_MSandSANDBOX_SEARCH_TIMEOUT_MSare fixed budgets and not settings, and give the ingress202text inopenapi.jsonthe 5 s figure in place of the name. - Name 0.16.0, the first release without
ENABLE_SWAGGER=truein.env.example, in theSECURITY.mdnote on a copied.env. - State in the API reference how long a session
restrictionstays: a stop, start or logout keeps it until the engine reports a lift, the link reachesready, itsexpiresAtpasses or the session is deleted. - Say in the API reference that a cross-form reaction, like an edit or delete, needs a reported pairing and is otherwise neither stored nor announced.
- List the message receipts route among the chat-scoped routes in the API reference.
- Say in the API reference and the troubleshooting FAQ that a media
urlthat answers with a redirect is refused withDestination address is not allowed, and thatSSRF_ALLOWED_HOSTSdoes not lift it. - Say in the API reference and the engine caveats that the stored
bodyof an API-sent contact card, poll, location or captionless document differs by engine. - Say in the API reference and the engine caveats that under
STORE_EPHEMERAL_MESSAGES=falsethe whatsapp-web.js history read and chat list still return a disappearing message, which WhatsApp Web holds until it expires. - State in the integration guide that the reconciler's sweep goes on past unreadable pending ingress rows however many there are, and that with more than about a thousand of them the retention hand-off does not dead-letter the healthy rows behind them until the unreadable ones are repaired or deleted.
- Say in the API reference and the OpenAPI text that any member of a group whose info is not restricted to admins may edit its subject, description and picture, not only an admin.
- Say in the API reference that deleting a session leaves its stored media files in the media store until the orphan sweeps remove them, one to two hours later with the defaults, and longer after a restart or when
statuses/orchat-media/holds more than 100000 unreferenced files, one more sweep for each further 100000. - Say in the migration guide that the
restore.shrefusal of a SQLite archive underDATABASE_TYPE=postgresis cleared by changingDATABASE_TYPEandDATABASE_NAMEwhere they are set, as an environment value (a composeenvironment:entry, a Helm ConfigMap) outranks./.env. - Add
chatNameto thetopChatsentries of the two statistics examples in the API reference. - Correct the API reference and the API collection on a plugin's config UI, which the dashboard shows alone in place of the generated form, with an error when its bridge does not start within 5 s, and show the secret mask as
***, as the gateway returns it. - Say in the API reference and
.env.examplethat a send byurlholds the whole body in memory, at least twice its size at the peak and on whatsapp-web.js more while the page call is in flight, and that only the per-key rate limit bounds how many run at once. - List the local media store and the storage export archive in the at-rest table of the security design: plaintext files, owner-only (
0600in0700directories). - Say in the MCP
SessionGetChatsandMessageSearchdescriptions, the plugin guide, theChatSummary.namecomment, the typed SDKs and the PHP client that a Baileys privacy-id chat with no name of its own listsname"" and, when the session can map the id, aphoneto show instead. - Say in the security design that a host other users can log in to should run the gateway with
TMPDIRset to a directory only its user can enter, since the engine libraries stage the media of an upload in the temporary directory. - Say in the API reference that, while the database cannot be read, the chat match of a chat-restricted key falls back to the gateway's in-memory mappings, which do not see a mapping another gateway node has changed since.
- Say in the API reference and the troubleshooting guide how long the whatsapp-web.js page reload
409can last, that no event marks its end, and how to retry on it (#2139). - Correct the migration guide: the 0.15.0 reload row no longer says to wait for a
readyevent that nothing announces, and the import troubleshooting rows describe the shipped import, which replaces everything, restores in a fixed order and rolls back whole. - Correct the troubleshooting guide's messaging entry (a send answers
201, the engine failure log line, no message queue, a history check both engines serve). - Point the migration guide at the CHANGELOG upgrade notes, which name the behavior changes of a release, where it named a Breaking marker that recent releases do not use.
- Correct the API reference: the plugin search provider shows as
plugin:<pluginId>andSEARCH_PROVIDERnever takes a plugin id,byTypeof the message statistics hastextand counts only messages with a body or metadata, an emptyurlbesidebase64of a status post is accepted, the import example carries its notice, the seeded key lists(master key), the chats of a label answer404for a missing label only, andmessage.receivednames its optional fields. - Correct the troubleshooting guide's database locked step, which ran a command that checked nothing, to name the process that holds the file.
- Say in the troubleshooting guide that an
onboarding_dialog_unrecognizedwarning beside the page reload409means the "What's new" screen of WhatsApp Web is open in a language the gateway does not recognise. - Say in the troubleshooting guide that an icon with no text prints under its icon name (
ic-close) in the lists of anonboarding_dialog_unrecognizedwarning, and that it is not the label to add.
Dependencies
- Update
whatsapp-web.jsto 1.34.8, which carries the message-id fix OpenWA backported, the media-id fix and a LID-aware block and unblock, and ends its wait for the page's connection to WhatsApp afterWWEBJS_AUTH_TIMEOUT_MS(see Upgrade notes); the ready-sync patch now keeps only theeventsAttachedmarker. - Update
@aws-sdk/client-s3to 3.1169.0,bullmqto 6.7.6,@bull-board/api,@bull-board/expressand@bull-board/nestjsto 9.13.1,typeormto 1.1.3,puppeteerto 25.17.0,dotenvto 18.0.10 and@nestjs/common,@nestjs/core,@nestjs/platform-express,@nestjs/platform-socket.io,@nestjs/websocketsand@nestjs/testingto 11.2.10 in the gateway. - Update
better-sqlite3to 13.2.0 in the gateway, which bundles SQLite 3.54.1. - Update
i18nextto 27.1.1,react-i18nextto 18.0.1 andlucide-reactto 1.73.0 in the dashboard bundle. react-i18next 18 ignoresshouldUnescape, so the API key confirmation no longer passes it. - Update
viteto 8.3.8,@vitejs/plugin-reactto 6.3.0 andjsdomto 31.0.1 in the dashboard,prettierto 3.10.1,typescript-eslintto 8.72.2 andeslintto 10.15.0 in the gateway and the dashboard, andconcurrentlyto 10.0.7 andsupertestto 7.3.2 in the gateway; these are build, lint and test tooling only. - Update
guzzlehttp/guzzleto 8.5.0 in the PHP SDK lockfile; this touches development and test setups only. - The image's Node.js 22.23.4 to 22.23.5, a security release for the
http,http2,https,tls,permissionandzlibmodules. - The built-in S3 storage image
pgsty/siloRELEASE.2026-09-16 to RELEASE.2026-11-12, a security release; an existingopenwa-miniocontainer keeps its image until it is recreated (seedocs/14-migration-guide.md). - The dashboard and SDK audits run the same per-advisory gate as the gateway's.
Upgrade notes (behavior changes)
- An MCP
MessageListcall that does not setinlineMediareturns each media message with an{ omitted, sizeBytes }marker in place of its payload, where it returned the base64 inline; passinlineMedia: trueto get the bytes.GET /api/sessions/{sessionId}/messagesstill inlines by default. - A source install that runs the Chrome Puppeteer downloads (no
PUPPETEER_EXECUTABLE_PATH) moves from Chrome 156 to 157 with Puppeteer 25.17.0, and the amd64 image moves from Chrome for Testing 157 to 158, so a rollback to 0.30.3 or earlier crosses a browser major and deletes the stored whatsapp-web.js logins unlesssessions/is restored from a backup taken before the first start on this release (seedocs/11-operational-runbooks.md); the arm64 image runs the chromium Debian ships when it is built, whose major can differ between releases; Baileys sessions are unaffected. - whatsapp-web.js 1.34.8 ends its wait for the page's connection to WhatsApp to open after
WWEBJS_AUTH_TIMEOUT_MS(30000 ms unless set), where 1.34.7 waited with no limit of its own; a start on a host where that connection takes longer now fails, and a session that endsfailedis not started again at boot byAUTO_START_SESSIONS. RaiseWWEBJS_AUTH_TIMEOUT_MSthere and start the session (seedocs/12-troubleshooting-faq.md). - A whatsapp-web.js unblock (
DELETE /api/sessions/{sessionId}/contacts/{contactId}/block) now unblocks only the entry under the number's privacy id; 0.26.0 to 0.30.3 also unblocked an entry the same person held under a second id, such as a phone-keyed block from before the LID migration. A contact that stays blocked after an unblock needs that entry unblocked on the phone. scripts/restore.shexits1before it writes anything when the archive holds the SQLite data store andDATABASE_TYPEispostgres; 0.30.3 exited0after writing a file the app never reads (seedocs/14-migration-guide.md).- With
STORE_EPHEMERAL_MESSAGES=false, Baileys no longer keeps incoming disappearing messages, so a reply, forward, reaction, star, pin, unpin, delete by id, button click or quote of one, a group read receipt that names one, and an encrypted edit, reaction or vote aimed at it, no longer work, an RSVP to an event posted there is not reported, and the chat list carries nolastMessagetext for one. Rows stored before the upgrade stay until the store's count cap evicts them. - The SSRF guard refuses the documentation and benchmarking blocks (
192.0.2.0/24,198.51.100.0/24,203.0.113.0/24,2001:db8::/32,3fff::/20,2001:2::/48, also in their 6to4, NAT64 and IPv4-mapped spellings) and the 6a44 relay anycast address192.88.99.2, as it already refused198.18.0.0/15; a webhook, media or plugin url that points into one is refused, and a receiver on such an address needsSSRF_ALLOWED_HOSTS. - With the queue on, an ingress event row stays
pending, with its payload, until the worker settles it, where it was markeddispatchedwith its payload cleared as soon as its job was queued; while Redis cannot be asked, the reconciler replays nothing inline, where it used to; with the queue off, a pending ingress row, like a stranded webhook outbox row, is replayed inline whatever Redis still holds, so a job left in the ingress or webhook queue runs again when the queue is turned back on: let both queues drain before turning it off (seedocs/25-integration-fabric.md). - In a plugin config list with a secret column, a save of the same length in which a row matched by its other fields, whatever its own secret, changes position, such as removing a row ahead of a kept one and adding another, or reordering rows, saves a row renamed in place, with its mask untouched, without its secret; enter that secret again (see
docs/19-plugin-architecture.md). - An installed plugin whose manifest declares
ingressthat is not a list, an hmac-sha256contentTemplatethat is not a string, or aheader,timestampHeader(hmac-sha256 and shared-secret routes),dedupHeaderorconversationId.headerthat is not a string no longer loads at boot (statuserror, and the log names the route and the field), where 0.30.3 loaded it and failed that route on every delivery; correct the field and update the plugin. - A
ctx.storagekey that holds a lone UTF-16 surrogate is refused:setanddeletereject it as an unsafe key andgetanswersnull; a record an earlier version wrote under one stays reachable through the key spelled withU+FFFD. - A process that reads the local media directory or the storage export archives as a user other than the one the gateway runs as, such as a static file server or a backup job under another uid, loses access: the media root becomes
0700at the next boot, whateverSTORAGE_TYPEis,data/exportsbecomes0700, and new files are0600. Files written earlier keep their mode but sit under the0700root. A media directory the gateway does not own keeps its mode and a warning is logged at boot. Run such a reader as the gateway's user (the image runs asopenwa). WithSTORAGE_TYPE=s3the directory matters only while it still holds files: those stored before the move to s3 and the fallback written while the bucket was unreachable. - Baileys lists
nameas "" for a chat held under a privacy id that has no saved, verified or push name, with itsphonewhen the session maps the id, where 0.30.3 listed the id's own digits: title such a chat byphone, else byid. This reachesGET /api/sessions/{sessionId}/chats, the MCPSessionGetChatstool and a plugin'sgetChats. Every Baileys chatnameis also trimmed, and a blank name of any other chat lists the contact's name or the id's digits, where 0.30.3 listed it as it came. - In a plugin config list with a secret column, a row that differs from another only by its secret, and was edited or removed in a save of the same length in which a row moved, is saved without its secret; enter that secret again (see
docs/19-plugin-architecture.md). - The
409a whatsapp-web.js session answers while WhatsApp Web reloads its page has a new message ("Retry every few seconds: this can last a few minutes.") and carriescodeENGINE_PAGE_RELOADINGandretryAfterSeconds. A client that matched the old text, "Retry in a few seconds.", must match thecode.