Webhooks

Chat Archived/Unarchived

Triggered when a chat's archive status changes.

Best practices

  • Store the 'archived' boolean to filter chats in your list view.

  • Ensure sync between mobile app movements and your custom CRM.

Archive Management

Fired whenever you or a sync action moves a chat into/out of the archived folder.

Key Fields

  • chatId: The individual or group ID.
  • archived: true if moved to archive, false if moved back to active.

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 *
string *
object *
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

Command Palette

Search for a command to run...