Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(audit): say which session connection actions are audited

Yudhi Armyndharis31fb91ca4128
diff --git a/src/modules/audit/entities/audit-log.entity.ts b/src/modules/audit/entities/audit-log.entity.ts
index 75ba7ff10..d2deff3ce 100644
--- a/src/modules/audit/entities/audit-log.entity.ts
+++ b/src/modules/audit/entities/audit-log.entity.ts
@@ -27,8 +27,9 @@ export enum AuditAction {
SESSION_QR_GENERATED = 'session_qr_generated',
SESSION_CONNECTED = 'session_connected',
SESSION_DISCONNECTED = 'session_disconnected',
- // WhatsApp's own judgement of the account, not our connection to it. Unlike the two above these
- // ARE audited: they are rare, they are not reconnect noise, and the in-memory store that serves
+ // WhatsApp's own judgement of the account, not our connection to it. Unlike SESSION_CONNECTED (never
+ // emitted) and SESSION_DISCONNECTED (emitted only for a terminal unlink), these are always audited:
+ // they are rare, they are not reconnect noise, and the in-memory store that serves
// them to the API does not survive a restart — so the audit log is the only durable record of when
// an account was restricted and for how long.
SESSION_RESTRICTED = 'session_restricted',