glossary docs
glossary docs

Glossary of Terms

Complete dictionary of concepts, database variables, and gateway terms used in WhatAPI.

Glossary of Terms

A reference glossary defining technical terms and database attributes used across the WhatAPI portal and specifications.

Gateway & Backend Terms

  • OpenWA: The backend WhatsApp automation gateway, built around standard client libraries (Baileys/wa-automate), running persistent headless worker sessions.
  • PM2: Node.js process manager running on our Hetzner CX42 VPS node. It keeps backend worker scripts running 24/7 and restarts them if they crash.
  • SQLite Session File: A local file (`.db`) created on the Hetzner node for each active session. It caches device connection keys, enabling rapid reconnection without re-scanning the QR code.
  • Firebase JWT: Firebase Authentication JSON Web Token used to securely authenticate requests to `/api/client/*` endpoints in the `Authorization: Bearer <Token>` header.
  • Webhook Callback: An automated POST call from WhatAPI to your endpoint, triggered when message statuses change (delivered, read) or e-commerce events occur.

Firestore Schema Attributes

  • whatsappSessionId: The unique string key assigned to a client's account that identifies their session in OpenWA.
  • whatsappConnected: Boolean flag (true/false) in the `users` collection indicating whether the phone is currently paired and connected.
  • messagesSent: Integer tracking the total messages processed during the billing cycle.
  • messagesLimit: The monthly message quota associated with the client's current pricing plan (Starter: 1,500, Growth: 5,000, Business: 25,000).
  • sortOrder: Integer defining the vertical sorting order of elements (such as pricing cards and template pages).