{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "chat_id": "919537851844@c.us",
    "members": {
        "918527184400@c.us": {
            "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
            "chat_id": "919537851844@c.us",
            "is_admin": true,
            "org_phone": "918527184400@c.us",
            "contact_id": "918527184400@c.us",
            "is_internal": true,
            "contact_name": "Support",
            "contact_color": "#B4876E",
            "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
            "is_super_admin": true
        },
        "919537851844@c.us": {
            "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
            "chat_id": "919537851844@c.us",
            "is_admin": true,
            "org_phone": "918527184400@c.us",
            "contact_id": "919537851844@c.us",
            "is_internal": false,
            "contact_name": "BK Local1",
            "contact_color": "#B4876E",
            "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
            "is_super_admin": true
        }
    },
    "is_muted": false,
    "chat_name": "BK Local1",
    "chat_type": "user",
    "closed_at": null,
    "is_exited": false,
    "label_ids": {
        "label-xbitdvipqshahdcu": true,
        "label-xgargwpbzidjpapt": true
    },
    "org_phone": "918527184400@c.us",
    "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
    "created_at": "2025-01-18T14:51:03+00:00",
    "updated_at": "2025-01-27T11:08:10.696758+00:00",
    "assigned_to": "bharat@hashlabs.dev",
    "chat_access": {
        "bharat@hashlabs.dev": true
    },
    "invite_link": null,
    "common_chats": [
        "120363329861739657@g.us",
        "120363331984403446@g.us",
        "120363352652386702@g.us",
        "120363371655584481@g.us",
        "120363372525172897@g.us",
        "120363373761356282@g.us",
        "120363378751945209@g.us",
        "120363387379991154@g.us",
        "120363387670530253@g.us",
        "120363388696354849@g.us",
        "120363389171465741@g.us",
        "120363391093262494@g.us",
        "120363392071406466@g.us",
        "120363392706769636@g.us",
        "919537851844@c.us"
    ],
    "member_count": 2,
    "flag_count_map": null,
    "latest_message": {
        "id": {
            "id": "3EB0297C336FD627EAF4447CFC1DEB49394D7874",
            "remote": "919537851844@c.us",
            "from_me": true,
            "serialized": "true_919537851844@c.us_3EB0297C336FD627EAF4447CFC1DEB49394D7874"
        },
        "to": null,
        "ack": "4",
        "fts": "'/invite/cuzauensb6e8sk7r3dopd3':12 '1040':9 'activ':29 'becom':28 'cannot':15 'chat.whatsapp.com':11 'chat.whatsapp.com/invite/cuzauensb6e8sk7r3dopd3':10 'click':16 'invit':4 'join':6 'link':18,26 'messag':23 'new':8 'pleas':19 'respond':20 'test':7",
        "body": "You have been invited to join Test New 1040\n\nhttps://chat.whatsapp.com/invite/CuZAuEnSB6e8sk7R3dopD3\n\nIf you cannot click the link, please respond to this message, and the link will become active",
        "from": null,
        "links": null,
        "media": null,
        "token": null,
        "author": null,
        "is_gif": null,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "vcards": null,
        "chat_id": "919537851844@c.us",
        "from_me": true,
        "duration": null,
        "location": null,
        "order_id": null,
        "raw_data": null,
        "broadcast": null,
        "has_media": null,
        "invite_v4": null,
        "is_status": null,
        "media_key": null,
        "org_phone": "918527184400@c.us",
        "poll_info": null,
        "prev_body": null,
        "timestamp": "2025-01-27T11:07:56+00:00",
        "unique_id": "3EB0297C336FD627EAF4447CFC1DEB49394D7874",
        "is_deleted": null,
        "is_starred": null,
        "message_id": "true_919537851844@c.us_3EB0297C336FD627EAF4447CFC1DEB49394D7874",
        "updated_at": "2025-01-27T11:08:10.693+00:00",
        "device_type": null,
        "flag_status": null,
        "broadcast_id": null,
        "has_reaction": null,
        "is_ephemeral": null,
        "is_forwarded": null,
        "message_type": "chat",
        "performed_by": null,
        "poll_results": null,
        "sender_phone": "918527184400@c.us",
        "delivery_info": {
            "read": {
                "919537851844@c.us": 1737976090690
            },
            "pending": [],
            "delivered": {
                "919537851844@c.us": 1737976082277
            },
            "read_count": 1,
            "delivered_count": 1
        },
        "flag_metadata": null,
        "mentioned_ids": [],
        "has_quoted_msg": null,
        "sent_message_id": "f97ac2f7-2a2d-43b3-8f6c-dfb17973b1b9",
        "forwarding_score": null,
        "message_ticket_id": null,
        "quoted_message_id": null,
        "flag_response_time": null
    },
    "chat_org_phones": [
        "918527184400@c.us"
    ],
    "hubspot_metadata": {},
    "info_admins_only": null,
    "custom_properties": {
        "property-tlkudzxmhjkgoktm": "hello"
    },
    "group_description": null,
    "message_unread_count": null,
    "messages_admins_only": null,
    "add_members_admins_only": null
}

{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "chat_id": "919537851844@c.us",
    "members": {
        "918527184400@c.us": {
            "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
            "chat_id": "919537851844@c.us",
            "is_admin": true,
            "org_phone": "918527184400@c.us",
            "contact_id": "918527184400@c.us",
            "is_internal": true,
            "contact_name": "Support",
            "contact_color": "#B4876E",
            "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
            "is_super_admin": true
        },
        "919537851844@c.us": {
            "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
            "chat_id": "919537851844@c.us",
            "is_admin": true,
            "org_phone": "918527184400@c.us",
            "contact_id": "919537851844@c.us",
            "is_internal": false,
            "contact_name": "BK Local1",
            "contact_color": "#B4876E",
            "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
            "is_super_admin": true
        }
    },
    "is_muted": false,
    "chat_name": "BK Local1",
    "chat_type": "user",
    "closed_at": null,
    "is_exited": false,
    "label_ids": {
        "label-xbitdvipqshahdcu": true,
        "label-xgargwpbzidjpapt": true
    },
    "org_phone": "918527184400@c.us",
    "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
    "created_at": "2025-01-18T14:51:03+00:00",
    "updated_at": "2025-01-27T11:08:10.696758+00:00",
    "assigned_to": "bharat@hashlabs.dev",
    "chat_access": {
        "bharat@hashlabs.dev": true
    },
    "invite_link": null,
    "common_chats": [
        "120363329861739657@g.us",
        "120363331984403446@g.us",
        "120363352652386702@g.us",
        "120363371655584481@g.us",
        "120363372525172897@g.us",
        "120363373761356282@g.us",
        "120363378751945209@g.us",
        "120363387379991154@g.us",
        "120363387670530253@g.us",
        "120363388696354849@g.us",
        "120363389171465741@g.us",
        "120363391093262494@g.us",
        "120363392071406466@g.us",
        "120363392706769636@g.us",
        "919537851844@c.us"
    ],
    "member_count": 2,
    "flag_count_map": null,
    "latest_message": {
        "id": {
            "id": "3EB0297C336FD627EAF4447CFC1DEB49394D7874",
            "remote": "919537851844@c.us",
            "from_me": true,
            "serialized": "true_919537851844@c.us_3EB0297C336FD627EAF4447CFC1DEB49394D7874"
        },
        "to": null,
        "ack": "4",
        "fts": "'/invite/cuzauensb6e8sk7r3dopd3':12 '1040':9 'activ':29 'becom':28 'cannot':15 'chat.whatsapp.com':11 'chat.whatsapp.com/invite/cuzauensb6e8sk7r3dopd3':10 'click':16 'invit':4 'join':6 'link':18,26 'messag':23 'new':8 'pleas':19 'respond':20 'test':7",
        "body": "You have been invited to join Test New 1040\n\nhttps://chat.whatsapp.com/invite/CuZAuEnSB6e8sk7R3dopD3\n\nIf you cannot click the link, please respond to this message, and the link will become active",
        "from": null,
        "links": null,
        "media": null,
        "token": null,
        "author": null,
        "is_gif": null,
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "vcards": null,
        "chat_id": "919537851844@c.us",
        "from_me": true,
        "duration": null,
        "location": null,
        "order_id": null,
        "raw_data": null,
        "broadcast": null,
        "has_media": null,
        "invite_v4": null,
        "is_status": null,
        "media_key": null,
        "org_phone": "918527184400@c.us",
        "poll_info": null,
        "prev_body": null,
        "timestamp": "2025-01-27T11:07:56+00:00",
        "unique_id": "3EB0297C336FD627EAF4447CFC1DEB49394D7874",
        "is_deleted": null,
        "is_starred": null,
        "message_id": "true_919537851844@c.us_3EB0297C336FD627EAF4447CFC1DEB49394D7874",
        "updated_at": "2025-01-27T11:08:10.693+00:00",
        "device_type": null,
        "flag_status": null,
        "broadcast_id": null,
        "has_reaction": null,
        "is_ephemeral": null,
        "is_forwarded": null,
        "message_type": "chat",
        "performed_by": null,
        "poll_results": null,
        "sender_phone": "918527184400@c.us",
        "delivery_info": {
            "read": {
                "919537851844@c.us": 1737976090690
            },
            "pending": [],
            "delivered": {
                "919537851844@c.us": 1737976082277
            },
            "read_count": 1,
            "delivered_count": 1
        },
        "flag_metadata": null,
        "mentioned_ids": [],
        "has_quoted_msg": null,
        "sent_message_id": "f97ac2f7-2a2d-43b3-8f6c-dfb17973b1b9",
        "forwarding_score": null,
        "message_ticket_id": null,
        "quoted_message_id": null,
        "flag_response_time": null
    },
    "chat_org_phones": [
        "918527184400@c.us"
    ],
    "hubspot_metadata": {},
    "info_admins_only": null,
    "custom_properties": {
        "property-tlkudzxmhjkgoktm": "hello"
    },
    "group_description": null,
    "message_unread_count": null,
    "messages_admins_only": null,
    "add_members_admins_only": null
}

Attributes

​
org_id
string

The unique identifier of the organization that owns the WhatsApp account.

​
chat_id
string

The unique identifier of the WhatsApp chat (format: {phone_number}@c.us for individual chats or {group_id}@g.us for groups).

​
members
object

A map of members in the chat, keyed by WhatsApp ID (format: {phone_number}@c.us).

​
chat_name
string

The display name of the chat. For groups, this is the group name. For individual chats, this is the contact’s name.

​
chat_type
string

The type of chat. Can be group, user, or business.

​
chat_labels
string

Comma-separated labels associated with the chat on Periskope.

​
org_phone
string

The WhatsApp ID of the organization’s account (format: {phone_number}@c.us).

​
chat_image
string

The URL of the chat’s profile image.

​
created_at
string

The ISO 8601 formatted timestamp when the chat was created.

​
updated_at
string

The ISO 8601 formatted timestamp when the chat was last updated.

​
latest_message
object

An object containing details about the latest message sent in the chat.

​
invite_link
string

The invite link of the chat.

​
is_muted
boolean

Indicates if notifications for this chat are muted.

​
is_archived
boolean

Indicates if the chat has been archived.

​
custom_properties
object

A map of custom properties associated with the chat. Values depend on the property type:

  • dropdown: Selected option from predefined choices
  • text: Text string value
  • date: Date value
​
group_description
string

The description text for group chats.

​
message_unread_count
number

The number of unread messages in the chat.

​
closed_at
string

The ISO 8601 formatted timestamp when the chat was closed, if applicable.

​
is_exited
boolean

Indicates if the organization has left this chat.

​
label_ids
object

A map of label identifiers associated with the chat, where keys are label IDs and values are booleans.

​
assigned_to
string

The email address of the user assigned to this chat.

​
chat_access
object

A map of user access permissions, where keys are email addresses and values are booleans.

​
common_chats
array

An array of chat IDs that are shared between the organization and the contact.

​
member_count
number

The total number of participants in the chat.

​
chat_org_phones
array

An array of organization WhatsApp IDs associated with this chat.

​
hubspot_metadata
object

Metadata related to HubSpot integration.

​
info_admins_only
boolean

Indicates if only admins can modify group info.

​
messages_admins_only
boolean

Indicates if only admins can send messages in the group.

​
add_members_admins_only
boolean

Indicates if only admins can add new members to the group.

Was this page helpful?

AuthorizationThe Chat Notification Object