The Chat Notification Object
The Chat Notification object represents a chat update notification in WhatsApp.
Attributes
The unique identifier of the organization that owns the WhatsApp account.
The unique identifier of the WhatsApp chat or group where the notification occurred.
A unique identifier for the notification, typically containing information about the chat, action, and participant.
The WhatsApp ID of the user who triggered the notification (format: {phone_number}@c.us
).
The content of the notification message. Can be null for certain notification types.
Detailed identification information for the notification.
An array of WhatsApp IDs for the notification recipients (format: ["{phone_number}@c.us"]
).
The type of notification event. Possible values are add
, remove
, promote
, demote
, leave
,
announce_true
, announce_false
, restrict_true
, restrict_false
, memberaddmode_true
,
memberaddmode_false
, subject
, desc
, call
add
: A member was added to the group. If author is present, it indicates who added them; otherwise, they joined via an invite link.remove
: A member was removed from the group.promote
: A member was promoted to an admin role.demote
: Admin privileges were removed from a member.leave
: A user left the group.announce_true
: The group settings were changed to allow only admins to send messages.announce_false
: The group settings were changed to allow all members to send messages.restrict_true
: The group settings were changed to allow only admins to update group info (subject, description, icon).restrict_false
: The group settings were changed to allow all members to update group info.memberaddmode_true
: The group settings were changed to allow all members to add new members.memberaddmode_false
: The group settings were changed to allow only admins to add new members.subject
: The group subject was changed.desc
: The group description was changed.call
: Represents a call notification. See themetadata
field for more details about the call
The ISO 8601 formatted timestamp when the notification was created.
The WhatsApp ID of the organization’s account (format: {phone_number}@c.us
).
A unique identifier for the notification event, matching the id.id
field.
Additional metadata about the notification. For call notifications, this object contains information about the call.