Receiving Events

account.auth.required

The account needs (re)authentication — a code, QR scan, or 2FA.

Event payload

{
  "id": "evt_auth_3c4d5e6f7a",
  "type": "account.auth.required",
  "provider": "whatsapp",
  "account_id": "acc_8c21d0",
  "occurred_at": "2026-06-08T13:23:00Z",
  "data": {
    "auth_status": "awaiting_qr_scan",
    "runtime_status": "disconnected",
    "auth_payload": {
      "qr_code": "2@A1B2C3D4..."
    },
    "event": {
      "kind": "account_auth_status",
      "auth_status": "awaiting_qr_scan"
    }
  }
}

Notes

The account needs user action before it can come online. data.auth_status tells which step is waiting and data.auth_payload carries the material to render or show, such as qr_code, url, pin, or verify_code depending on provider and auth mode.