> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.
# How to Host WhatsApp Bots
> Learn to create and host Whatsapp bots on Square Cloud. Complete tutorial with configuration, deployment, and practical example in Node.js.
export const RecommendedPlan = ({lang, plan, tier, cpu, appType}) => {
const siteLang = lang === 'pt-br' ? 'pt-br' : 'en';
const url = `https://squarecloud.app/${siteLang}/pay?plan=${plan.toLowerCase()}&tier=${tier}`;
const proUrl = `https://squarecloud.app/${siteLang}/pay?plan=pro`;
const notes = {
'en':
Wondering how much RAM and CPU your plan needs to host {appType}?
Don't worry, we're here to help.
Our {plan} plan offers {tier}GB of RAM and {cpu}vCPU, which should be sufficient for most {appType}.
However, if you are working on a larger project and seeking extra stability, we recommend considering our Pro plan. With additional resources, you can maintain stability even during demand spikes.
To purchase, simply click here.
,
'pt-br':
Está se perguntando quanta RAM e CPU seu plano precisa para hospedar {appType}?
Não se preocupe, estamos aqui para ajudar.
Nosso plano {plan} oferece {tier}GB de RAM e {cpu}vCPU, o que deve ser suficiente para a maioria dos {appType}.
No entanto, se você estiver trabalhando em um projeto maior e precisar de mais estabilidade, recomendamos considerar nosso plano Pro.
Com recursos adicionais, você pode manter a estabilidade mesmo durante picos de demanda.
Para comprar, basta clicar aqui.
,
'es':
¿Te preguntas cuánta RAM y CPU necesita tu plan para alojar {appType}?
No te preocupes, estamos aquí para ayudarte.
Nuestro plan {plan} ofrece {tier}GB de RAM y {cpu}vCPU, lo que debería ser suficiente para la mayoría de {appType}.
Sin embargo, si estás trabajando en un proyecto más grande y buscas mayor estabilidad, te recomendamos considerar nuestro plan Pro.
Con recursos adicionales, puedes mantener la estabilidad incluso durante picos de demanda.
Para comprarlo, simplemente haz clic aquí.
,
'fr':
Vous vous demandez combien de RAM et de CPU votre plan doit offrir pour héberger {appType} ?
Pas d'inquiétude, nous sommes là pour vous aider.
Notre plan {plan} offre {tier} Go de RAM et {cpu} vCPU, ce qui devrait suffire pour la plupart des {appType}.
Cependant, si vous travaillez sur un projet plus important et recherchez une stabilité accrue, nous vous recommandons notre plan Pro.
Avec des ressources supplémentaires, vous conservez la stabilité même lors des pics de demande.
Pour l'acheter, cliquez simplement ici.
,
'de':
Sie fragen sich, wie viel RAM und CPU Ihr Plan zum Hosten von {appType} benötigt?
Keine Sorge, wir helfen Ihnen gerne.
Unser {plan}-Plan bietet {tier} GB RAM und {cpu} vCPU, was für die meisten {appType} ausreichen sollte.
Wenn Sie jedoch an einem größeren Projekt arbeiten und zusätzliche Stabilität benötigen, empfehlen wir unseren Pro-Plan.
Mit zusätzlichen Ressourcen bleibt Ihre Anwendung auch bei Lastspitzen stabil.
Zum Kauf klicken Sie einfach hier.
,
'it':
Ti stai chiedendo quanta RAM e CPU serve al tuo piano per ospitare {appType}?
Non preoccuparti, siamo qui per aiutarti.
Il nostro piano {plan} offre {tier}GB di RAM e {cpu}vCPU, che dovrebbero essere sufficienti per la maggior parte di {appType}.
Tuttavia, se stai lavorando a un progetto più grande e cerchi maggiore stabilità, ti consigliamo il nostro piano Pro.
Con risorse aggiuntive puoi mantenere la stabilità anche durante i picchi di richieste.
Per acquistarlo, fai clic qui.
,
'ja':
{appType}のホスティングに必要なRAMとCPUの容量が気になりますか？
ご安心ください。私たちがサポートします。
{plan}プランは{tier}GBのRAMと{cpu}vCPUを提供しており、ほとんどの{appType}には十分です。
より大規模なプロジェクトでさらなる安定性を求める場合は、Proプランをおすすめします。追加リソースにより、需要のピーク時でも安定性を維持できます。
ご購入はこちらをクリックしてください。
,
'zh':
想知道托管{appType}需要多少 RAM 和 CPU 吗？
别担心，我们来帮您。
我们的 {plan} 套餐提供 {tier}GB RAM 和 {cpu}vCPU，对大多数{appType}来说已经足够。
如果您的项目规模更大、需要更高的稳定性，我们推荐 Pro 套餐。借助额外资源，即使在需求高峰期也能保持稳定。
点击这里即可购买。
};
return notes[lang] || notes['en'];
};
export const appType_0 = "a Whatsapp bot"
## Introduction
To develop and host {appType_0} on Square Cloud, it's essential to follow a structured sequence of configurations and prerequisites. This technical guide will cover the entire process, from initial setup to production deployment.
### Prerequisites
* **Square Cloud Account**: Register through the [signup page](https://squarecloud.app/en/signup) using your email.
* **Active Paid Plan**: Ensures dedicated resources and optimized performance for your application. Check our [available plans](https://squarecloud.app/en/pricing) and choose the most suitable for your needs.
## Creating project
WhatsApp installed and configured is required for bot authentication and linking. If you don't have the app, visit the [official WhatsApp website](https://www.whatsapp.com/coronavirus/get-started?lang=en) for download and setup.
If your implementation needs to access the remote path for the WhatsApp Web version, follow this technical procedure:
1. Access the [wa-version](https://github.com/wppconnect-team/wa-version/tree/main/html) repository
2. Select the desired version (always recommended to use the latest)
3. Click "Raw" to view the file
4. Copy the generated URL for later use
**Example configured URL:**
```
https://raw.githubusercontent.com/wppconnect-team/wa-version/main/html/2.2412.54.html
```
### Developing project
1. **Node.js verification**: Confirm that Node.js is installed on your system. Otherwise, download it from the [official Node.js website](https://nodejs.org/).
2. **Project initialization**: Set up a new Node.js project by running the initialization command:
```bash Terminal theme={null}
npm init -y
```
3. **Dependencies installation**: Install the essential libraries for bot functionality:
```bash Terminal theme={null}
npm install whatsapp-web.js qrcode
```
4. **Main file creation**: Develop the `index.js` file with the bot's base structure:
```javascript index.js theme={null}
// Import necessary modules
const { Client } = require("whatsapp-web.js");
const qrcode = require("qrcode");
// Create a new WhatsApp client instance
const client = new Client({
puppeteer: {
// Run Chrome in headless mode (without graphical interface)
headless: true,
args: [
// Disable Chrome sandboxing features
// Required for execution in containerized environments
"--no-sandbox",
// Additional sandboxing flag to disable setuid sandbox
"--disable-setuid-sandbox",
],
},
// Web version cache configuration
webVersionCache: {
// Type "remote" indicates WhatsApp Web version will be fetched from remote URL
type: "remote",
// Remote path for WhatsApp Web version
remotePath: "INSERT_YOUR_URL_HERE",
},
});
// Event listener for QR Code generation
client.on("qr", async (qr) => {
// Use qrcode library to generate and save QR Code
try {
await qrcode.toFile("./qrcode.png", qr);
console.log("QR Code generated and saved as qrcode.png");
} catch (err) {
console.error("Error generating QR Code:", err);
}
});
// Event listener for client ready
client.on("ready", () => {
// Confirmation log when WhatsApp Web session is established
console.log("WhatsApp client successfully initialized!");
});
// Event listener for created messages
client.on("message_create", (msg) => {
// Log message content to console
console.log("Message received:", msg.body);
// Test command implementation
if (msg.body === "!ping") {
// Automatic response for ping command
msg.reply("pong - Bot working correctly!");
}
});
// Initialize WhatsApp client
client.initialize();
```
## Deploying
After preparing your project files, you can now upload them to Square Cloud and host your project.
To do so, create a ZIP file containing all your project files.
### Via dashboard
Access the [upload page](https://squarecloud.app/en/dashboard/new) and upload your project zip file.
After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.\
If you are uploading a web project, make sure to select "Web Publication" and set a subdomain to your project.
Finally, click on the "Deploy" button to host your project on Square Cloud.\
After deployment, you can monitor your project's status and logs from the dashboard.
Your first deploy usually takes less than a minute. In the [dashboard](https://squarecloud.app/en/dashboard), wait for your application status to show as running and check the logs for any startup errors.\
If you deployed a website or API, open `https://.squareweb.app` in your browser — you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
App not starting? See the [Troubleshooting guide](/en/platform/troubleshooting/app-wont-start) for the most common causes and fixes.
### Via CLI
To use this method, you need to create a config file named `squarecloud.app` in the root directory of your project. This file will contain the necessary configuration for your project.
Learn how to create the `squarecloud.app` configuration file that defines your application's environment.
First, you need to have the CLI installed in your environment. If you don't have it yet, run the following command in your terminal:
```
npm install -g @squarecloud/cli
```
If you already have it, we recommend updating it. To do this, run the following command in your terminal:
```bash theme={null}
squarecloud update
```
```bash theme={null}
curl -fsSL https://cli.squarecloud.app/install | bash
```
Now, to authenticate and use other CLI commands, you will find your authorization key [here](https://squarecloud.app/en/account/security) by clicking on "Request API Key". After obtaining your authorization key, run the following command:
```bash theme={null}
squarecloud auth login
```
Finally, to deploy your application to Square Cloud using the CLI, you need to run the following command:
```bash theme={null}
squarecloud upload
```
Or if you created the zip manually, you can use:
```bash theme={null}
squarecloud upload --file
```
Your first deploy usually takes less than a minute. Check your application status and logs directly from the terminal:
```bash theme={null}
squarecloud app status
squarecloud app logs
```
If you deployed a website or API, open `https://.squareweb.app` in your browser — you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
App not starting? See the [Troubleshooting guide](/en/platform/troubleshooting/app-wont-start) for the most common causes and fixes.
## Testing the Bot
Check the application logs in the Square Cloud dashboard: on first boot you'll see the QR Code generation log, and once you scan it with WhatsApp on your phone, the `WhatsApp client successfully initialized!` message confirms the session is active. Then send `!ping` from another number to the linked WhatsApp account and confirm it replies with `pong - Bot working correctly!`.
## Using Baileys instead of whatsapp-web.js
[Baileys](https://github.com/WhiskeySockets/Baileys) is an alternative library that connects to WhatsApp's multi-device API directly over a WebSocket, without launching a headless browser. Since there's no Chromium/Puppeteer instance to run, it uses significantly less RAM than whatsapp-web.js.
Because Baileys has no browser session to fall back on, it must persist its own authentication state (the `creds.json` file and keys inside the auth folder) between restarts, or the linked device session is lost on every redeploy and you'll need to scan the QR Code again. We recommend committing that auth folder to persistent storage, such as [Square Cloud Blob Storage](/en/services/blob), so the session survives redeploys.
1. Install the library:
```bash Terminal theme={null}
npm install @whiskeysockets/baileys
```
2. Create an `index.js` file using `makeWASocket` and `useMultiFileAuthState` to load and persist the session:
```javascript index.js theme={null}
const { makeWASocket, useMultiFileAuthState } = require("@whiskeysockets/baileys");
const qrcode = require("qrcode");
async function startBot() {
// Load (or create) the authentication state from the "auth" folder.
// Persist this folder (e.g. via Blob Storage) so the session survives redeploys.
const { state, saveCreds } = await useMultiFileAuthState("auth");
const sock = makeWASocket({
auth: state,
});
// Persist updated credentials whenever Baileys rotates them
sock.ev.on("creds.update", saveCreds);
// Surface the QR code on first login and reconnect when the socket closes
sock.ev.on("connection.update", async ({ connection, qr, lastDisconnect }) => {
if (qr) {
await qrcode.toFile("./qrcode.png", qr);
console.log("QR Code generated and saved as qrcode.png - scan it with WhatsApp");
}
if (connection === "close") {
const loggedOut = lastDisconnect?.error?.output?.statusCode === 401;
if (!loggedOut) startBot();
}
});
// Reply to a basic command
sock.ev.on("messages.upsert", async ({ messages }) => {
const msg = messages[0];
if (!msg.message || msg.key.fromMe) return;
if (msg.message.conversation === "!ping") {
await sock.sendMessage(msg.key.remoteJid, { text: "pong - Bot working correctly!" });
}
});
}
startBot();
```
Since Baileys doesn't need a browser, its configuration file on Square Cloud can use a lower `MEMORY` value than the whatsapp-web.js example above:
```systemd squarecloud.config theme={null}
MAIN=index.js
MEMORY=512
VERSION=recommended
```
## Additional resources
To deepen your knowledge about WhatsApp bot development using whatsapp-web.js, consult the [official whatsapp-web.js library documentation](https://wwebjs.dev/). The documentation offers detailed technical guides, advanced tutorials, and complete API reference to maximize implementation potential.
## Contact us
If you continue facing **technical difficulties**, our **specialized support team** is available to assist you. [**Contact us**](https://squarecloud.app/en/support) and we'll be happy to help you resolve any issue — support quality is a big part of why developers rate Square Cloud [**4.9/5 across 402 reviews**](https://www.trustpilot.com/review/squarecloud.app) on Google and Trustpilot.