Session Status Change

This event is triggered when the session status changes (e.g., from WORKING to STOPPED).

Uptime Monitoring

Use this event to detect if your WhatsApp instance goes offline so you can alert your support team or trigger an automated restart.

Status Mapping

The 'status' field returns values like WORKING, STOPPED, and SCAN_QR_CODE.

Best practices

Store the 'WORKING' status in your database to prevent sending messages to an offline instance.
Notify administrators immediately if a session moves to 'SCAN_QR_CODE' status.
Use the 'session' field to identify which account changed status.

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_01aaaaaaaaaaaaaaaaaaaaaaaa",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "session.status",
"payload": {
  "name": "default",
  "status": "STOPPED"
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123123@lid",
  "pushName": "Wawp Instance"
  }
}

Previous TopicWebhooks Overview

Next TopicIncoming Message

Session Status Change

Best practices

Expected Responses

Example

Command Palette