Chat Archived/Unarchived

Triggered when a chat's archive status changes.

Folder Logic

Use this to organize chats in your custom dashboard similar to the official WhatsApp app.

Best practices

Store the 'archived' boolean to filter chats in your list view.
Ensure sync between mobile app movements and your custom CRM.

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Webhook Payload Example

application/json

string *

number *

string *

object *

string *

object *

Example

{
"id": "evt_01...",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "chat.archive",
"payload": {
  "chatId": "11111111111@c.us",
  "archived": true
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}

Previous TopicPoll Vote Failed

Next TopicCall Received

Chat Archived/Unarchived

Best practices

Expected Responses

Example

Command Palette