Events
Generated reference for registered client events and their payloads.
Events
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
open-wa emits 10 events. Subscribe with the client helper (client.onMessage), the legacy listener name, or the event bus wildcard. Payload types are derived from each event's registered schema.
| Event | Legacy listener | Description | Payload | Status | License |
|---|---|---|---|---|---|
ack | onAck | Fired when a message acknowledgment is received | object { ack, chatId, id, timestamp } | stable | - |
addedToGroup | onAddedToGroup | Fired when you are added to a group | object { addedBy, groupId, groupName } | stable | - |
anyMessage | onAnyMessage | Fired for any message including own messages | object { ack, author, body, broadcast, caption, chat, chatId, clientUrl, content, deprecatedMms3Url, from, fromMe, id, invis, isForwarded, isGroupMsg, isMedia, isMMS, isNewMsg, isNotification, isPSA, isQuotedMsgAvailable, labels, mentionedJidList, notifyName, quotedMsg, quotedMsgObj, recvFresh, self, sender, senderId, star, t, timestamp, to, type } | stable | - |
chatState | onChatState | Fired when someone is typing or recording | object { chatId, senderId, state } | stable | - |
logout | onLogout | Fired when the session is logged out | object { reason, timestamp } | stable | - |
message | onMessage | Fired when a new message is received (excluding own messages) | object { ack, author, body, broadcast, caption, chat, chatId, clientUrl, content, deprecatedMms3Url, from, fromMe, id, invis, isForwarded, isGroupMsg, isMedia, isMMS, isNewMsg, isNotification, isPSA, isQuotedMsgAvailable, labels, mentionedJidList, notifyName, quotedMsg, quotedMsgObj, recvFresh, self, sender, senderId, star, t, timestamp, to, type } | stable | - |
messageDeleted | onMessageDeleted | Fired when a message is deleted | object { ack, author, body, broadcast, caption, chat, chatId, clientUrl, content, deprecatedMms3Url, from, fromMe, id, invis, isForwarded, isGroupMsg, isMedia, isMMS, isNewMsg, isNotification, isPSA, isQuotedMsgAvailable, labels, mentionedJidList, notifyName, quotedMsg, quotedMsgObj, recvFresh, self, sender, senderId, star, t, timestamp, to, type } | stable | - |
participantsChanged | onParticipantsChanged | Fired when group participants change | object { action, by, groupId, participantIds } | stable | - |
reaction | onReaction | Fired when a reaction is added to a message | object { messageId, reaction, senderId, timestamp } | stable | - |
stateChanged | onStateChanged | Fired when connection state changes | object { previousState, state } | stable | - |
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!