WILDCAT

https://notoriousarnav.github.io/wildcat
Admin
WILDCAT is an unofficial, enterprise-grade WhatsApp REST API for Node.js, enabling multi-account...
Tokens:33,256
Snippets:193
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install and Run WILDCAT Locally

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started

This snippet details the steps to clone the WILDCAT repository, install Node.js dependencies, set up the environment, and start the development server. It requires Git, Node.js, and npm.

```bash
git clone https://github.com/NotoriousArnav/wildcat.git
cd wildcat
npm ci
cp .env.example .env
npm run dev

```

--------------------------------

### Installation Guide

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Quick steps to clone the repository, install dependencies, and run the development server.

```APIDOC
## Installation Steps

### Description
Follow these commands to get WILDCAT up and running locally.

### Method
Shell Commands

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Deploy WILDCAT to Production Environment

Source: https://notoriousarnav.github.io/wildcat/docs/guides

Quick deployment script for getting WILDCAT running in production. Sets environment variables and starts the server. Requires Node.js and MongoDB. Best for initial setup and testing.

```bash
# 1. Choose deployment option
# Option 1: VPS (DigitalOcean, Linode)
# Option 2: Docker (Any cloud)
# Option 3: Heroku (Easiest)

# 2. Follow [Deployment Guide](/docs/guides/deployment/)

# 3. Set environment variables
export NODE_ENV=production
export MONGO_URL=your-mongo-url

# 4. Start server
npm start
```

--------------------------------

### Create a WILDCAT Account via API

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started

Demonstrates how to create a new account (bot) using the WILDCAT API. This involves making a POST request to the /accounts endpoint with a JSON payload containing the bot's ID and name. Requires a running WILDCAT instance.

```bash
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"mybot","name":"My Bot"}'

```

--------------------------------

### Start Server in Production Mode

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Starts the WILDCAT server in production mode with performance optimizations. Requires Node.js and npm to be installed.

```bash
npm start
```

--------------------------------

### Clone and Install WILDCAT Project on VPS

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

Clones the WILDCAT repository, installs project dependencies using npm ci, and sets up the environment variables. Requires Git and Node.js to be installed. Outputs are the cloned project files and installed node_modules.

```shell
# Create app directory
mkdir -p /opt/wildcat
cd /opt/wildcat

# Clone repository
git clone https://github.com/NotoriousArnav/wildcat.git .

# Install dependencies
npm ci

# Copy environment file
cp .env.example .env

# Edit configuration
sudo nano .env

```

--------------------------------

### Install PM2 and Manage WILDCAT Application

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet covers installing PM2 globally using npm, starting the WILDCAT application with a specified name, saving the PM2 configuration, and enabling auto-start on system reboot. It requires Node.js and npm to be installed, with no inputs needed but assumes the WILDCAT project files (e.g., index.js) are present. Limitations include requiring sudo privileges for global installs and system-level changes.

```shell
# Install PM2 globally
sudo npm install -g pm2

# Start WILDCAT
pm2 start index.js --name "wildcat"

# Save PM2 configuration
pm2 save

# Enable auto-start on reboot
pm2 startup
# (Copy and run the command it outputs)
```

--------------------------------

### WILDCAT Installation using Git and NPM

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

These commands clone the repository, install dependencies, configure environment, and start the development server. Requires Git, Node.js 18+, and NPM. Outputs a running server on port 3000; ensure .env is edited for MongoDB connection.

```bash
git clone https://github.com/NotoriousArnav/wildcat.git
cd wildcat
npm ci
cp .env.example .env
npm run dev
```

--------------------------------

### Local MongoDB Installation and Startup

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Installs and starts MongoDB locally on macOS, Linux, or Windows. Dependencies include Homebrew for macOS or system package manager for Linux; Windows requires manual download. Starts service on port 27017; check status with service commands.

```bash
# macOS
brew install mongodb-community
brew services start mongodb-community
```

```bash
# Linux
sudo systemctl start mongod
```

--------------------------------

### Install and Configure Nginx Reverse Proxy

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet installs Nginx, creates and edits a site configuration file, adds upstream and server block directives for proxying to WILDCAT on localhost:3000, enables the site, tests the configuration, and restarts Nginx. It depends on apt package manager and sudo access, with inputs being the domain name and port. Outputs include successful proxy setup; limitations involve manual configuration editing and potential domain-specific errors.

```shell
# Install Nginx
sudo apt install -y nginx

# Create Nginx config
sudo nano /etc/nginx/sites-available/wildcat
```

```nginx
upstream wildcat {
    server localhost:3000;
}

server {
    listen 80;
    server_name your-domain.com;

    location / {
        proxy_pass http://wildcat;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}
```

```shell
# Create symlink
sudo ln -s /etc/nginx/sites-available/wildcat /etc/nginx/sites-enabled/

# Test configuration
sudo nginx -t

# Restart Nginx
sudo systemctl restart nginx
sudo systemctl enable nginx
```

--------------------------------

### Send a WhatsApp Message via WILDCAT API

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started

Shows how to send a message to a WhatsApp number using the WILDCAT API. This requires a POST request to the /accounts/{accountId}/message/send endpoint with a JSON payload specifying the recipient and message content. Requires an existing account and a running WILDCAT instance.

```bash
curl -X POST http://localhost:3000/accounts/mybot/message/send \
  -H 'Content-Type: application/json' \
  -d '{ \
    "to": "919876543210@s.whatsapp.net", \
    "message": "Hello! 🐱" \
  }'

```

--------------------------------

### Build Docker Image for WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet clones the WILDCAT repository, builds a Docker image, and optionally tags it for a registry. It requires Git and Docker installed, with inputs being the repository URL. Outputs include a built image; limitations include network access for cloning and build dependencies in the Dockerfile.

```shell
# Clone repository
git clone https://github.com/NotoriousArnav/wildcat.git
cd wildcat

# Build image
docker build -t wildcat:latest .

# Tag for registry (optional)
docker tag wildcat:latest your-registry/wildcat:latest
```

--------------------------------

### Install Dependencies on Ubuntu (VPS Deployment)

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

Installs Node.js 18, Git, and MongoDB on an Ubuntu system. Assumes root or sudo privileges. Requires internet access to download packages and set up repositories.

```shell
# Update system
sudo apt update && sudo apt upgrade -y

# Install Node.js 18
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install -y nodejs

# Install Git
sudo apt install -y git

# Install MongoDB (or use MongoDB Atlas)
curl -fsSL https://www.mongodb.org/static/pgp/server-6.0.asc | sudo apt-key add -
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
sudo apt-get install -y mongodb-org

# Start MongoDB
sudo systemctl start mongod
sudo systemctl enable mongod

```

--------------------------------

### Install and Run n8n via Docker

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Runs n8n locally using Docker on port 5678. Optionally, users can sign up for n8n.cloud for hosted execution.

```bash
docker run -it --rm --name n8n -p 5678:5678 n8nio/n8n
# Or signup at https://n8n.io
```

--------------------------------

### MongoDB Setup

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Instructions for setting up MongoDB, either locally or using MongoDB Atlas.

```APIDOC
## MongoDB Setup

### Description
This section details the two options for setting up MongoDB: local installation or using MongoDB Atlas cloud service. It includes commands for macOS and Linux, and guidance for Windows and Atlas configuration.

### Method
Shell Commands / Manual Setup

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Install WILDCAT using npm and shell commands

Source: https://notoriousarnav.github.io/wildcat/docs

This snippet provides the quick installation steps for WILDCAT using npm and shell commands. It depends on Node.js and MongoDB, requiring users to configure environment variables for database connection. The result is a running development server; limitations include manual .env file editing and unsuitability for production without additional security measures.

```bash
npm ci
cp .env.example .env
# Edit .env with MONGO_URL and DB_NAME
npm run dev
```

--------------------------------

### Run and Manage Docker Compose Services for WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet starts Docker Compose services in detached mode, views logs, and stops services. It requires a docker-compose.yml file, with no inputs. Outputs include running containers; limitations include Docker daemon running and resource availability.

```shell
# Start services
docker-compose up -d

# View logs
docker-compose logs -f wildcat

# Stop services
docker-compose down
```

--------------------------------

### Deploy WILDCAT to Heroku

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet installs Heroku CLI, logs in, creates an app, adds MongoDB addon, clones the repo, adds Heroku remote, and deploys. It requires Heroku account and CLI, with inputs being app and addon names. Outputs include deployed application; limitations include Heroku account limits and Git integration.

```shell
# Install Heroku CLI
# https://devcenter.heroku.com/articles/heroku-cli

# Login
heroku login

# Create app
heroku create wildcat-your-name

# Add MongoDB Atlas add-on
heroku addons:create mongolab

# Clone repo
git clone https://github.com/NotoriousArnav/wildcat.git
cd wildcat

# Add Heroku remote
heroku git:remote -a wildcat-your-name

# Deploy
git push heroku main

# View logs
heroku logs --tail
```

--------------------------------

### Deploy WILDCAT Docker Image to Cloud Registry

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet logs into Docker Hub, pushes the tagged image, and mentions deploying to cloud providers. It requires a Docker image and registry credentials, with inputs being username and image name. Outputs include uploaded image; limitations involve account setup and network issues.

```shell
# Login
docker login

# Push image
docker push your-registry/wildcat:latest
```

--------------------------------

### Run Services with Docker Compose

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Starts MongoDB and WILDCAT services using Docker Compose. Includes commands to check logs and stop services.

```bash
docker-compose up -d
```

```bash
docker-compose logs -f wildcat
```

```bash
docker-compose down
```

--------------------------------

### Deploy with PM2 Process Manager

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Uses PM2 to manage the WILDCAT process in production, including starting, logging, and monitoring.

```bash
npm install -g pm2
```

```bash
pm2 start index.js --name "wildcat" --instances max
```

```bash
pm2 logs wildcat
```

```bash
pm2 monit
```

```bash
pm2 startup
pm2 save
```

--------------------------------

### Integrate WILDCAT with n8n Workflow

Source: https://notoriousarnav.github.io/wildcat/docs/guides

Step-by-step integration process for connecting WILDCAT with n8n workflow automation platform. Requires n8n installation (local or cloud) and basic understanding of webhook triggers. Ideal for visual workflow automation.

```bash
# 1. Install n8n locally or use n8n.cloud
# 2. Create webhook trigger
# 3. Add HTTP Request node to WILDCAT
# 4. Deploy workflow
```

--------------------------------

### Set Up HTTPS with Let's Encrypt Certbot

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet installs Certbot with Nginx plugin, obtains and auto-configures SSL certificates for the domain, and sets up auto-renewal. It requires a domain name and Nginx to be running, with no other inputs. Outputs include secure HTTPS connection; limitations include domain validation requirements and potential firewall issues.

```shell
# Install Certbot
sudo apt install -y certbot python3-certbot-nginx

# Get certificate (auto-setup)
sudo certbot --nginx -d your-domain.com

# Auto-renewal is automatic!

# Verify
sudo certbot renew --dry-run
```

--------------------------------

### Run Docker Containers Manually

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Manually starts MongoDB and WILDCAT containers with necessary environment variables and port mappings.

```bash
docker run -d --name mongodb -p 27017:27017 mongo:6.0
```

```bash
docker run -d --name wildcat \
  -p 3000:3000 \
  -e MONGO_URL=mongodb://mongodb:27017 \
  -e DB_NAME=wildcat \
  --link mongodb \
  wildcat:latest
```

```bash
curl http://localhost:3000/ping
```

--------------------------------

### Example: Full Workflow using cURL

Source: https://notoriousarnav.github.io/wildcat/docs/api

Demonstrates a complete workflow of interacting with the Wildcat API using cURL commands. It covers creating an account, listing accounts, sending a message, retrieving chats, and fetching messages from a chat. This example assumes a local development environment with the base URL set to http://localhost:3000.

```shell
# 1. Create account
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"mybot"}'

# (Scan QR code in terminal)

# 2. List accounts to verify
curl http://localhost:3000/accounts

# 3. Send message
curl -X POST http://localhost:3000/accounts/mybot/message/send \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "919876543210@s.whatsapp.net",
    "message": "Hello! 🐱"
  }'

# 4. Get chats
curl http://localhost:3000/accounts/mybot/chats

# 5. Get messages from chat
curl http://localhost:3000/accounts/mybot/chats/919876543210@s.whatsapp.net/messages

```

--------------------------------

### Build Docker Image for WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Builds a Docker image for the WILDCAT application. Requires Docker to be installed and configured.

```bash
docker build -t wildcat:latest .
```

```bash
docker images | grep wildcat
```

--------------------------------

### Testing Wildcat Webhook Registration and Delivery

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Command-line examples for troubleshooting Wildcat webhook issues. Includes a `curl` command to check registered webhooks and another `curl` command to manually test sending a POST request to a webhook URL with a JSON payload, simulating an incoming message.

```bash
# Check webhook is registered
curl http://localhost:3000/webhooks

# Test webhook manually
curl -X POST https://your-app.com/webhooks/whatsapp \
  -H 'Content-Type: application/json' \
  -d '{"from":"919876543210@s.whatsapp.net","text":"test"}'

```

--------------------------------

### GET /webhooks

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Retrieves the currently registered webhook URL.

```APIDOC
## GET /webhooks

### Description
Retrieves the currently configured webhook URL.

### Method
GET

### Endpoint
`/webhooks`

### Response
#### Success Response (200)
- **url** (string) - The registered webhook URL.

#### Response Example
```json
{
  "url": "https://your-app.com/webhooks/whatsapp"
}
```
```

--------------------------------

### Send Messages and Get Chats in Node.js

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Provides basic Node.js usage with axios to send messages and retrieve chats from WILDCAT. Demonstrates async/await and error handling.

```javascript
const axios = require('axios');

const WILDCAT_URL = 'http://localhost:3000';
const ACCOUNT_ID = 'mybot';

// Send message
async function sendMessage(to, message) {
  try {
    const response = await axios.post(
      `${WILDCAT_URL}/accounts/${ACCOUNT_ID}/message/send`,
      { to, message }
    );
    console.log('Message sent:', response.data.messageId);
    return response.data;
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

// Get chats
async function getChats() {
  try {
    const response = await axios.get(`${WILDCAT_URL}/accounts/${ACCOUNT_ID}/chats`);
    return response.data.chats;
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

// Usage
sendMessage('919876543210@s.whatsapp.net', 'Hello from Node.js!');
```

--------------------------------

### Use HTTPS for Secure Connections

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Always use HTTPS URLs for secure communication with APIs. This example shows the correct usage of an HTTPS URL compared to an insecure HTTP URL.

```text
// Good
url: "https://secure-api.example.com/webhook"
   
// Bad
url: "http://insecure.example.com/webhook"
```

--------------------------------

### Create n8n Webhook-Triggered Workflow for WhatsApp

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Configures a POST HTTP Webhook Trigger at path /whatsapp-webhook and an HTTP Request node to send replies via WILDCAT. Includes example JSON body for sending replies.

```json
{
  "to": "",
  "message": "Thanks for your message: "
}
```

--------------------------------

### GET /accounts/{accountId}/chats

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Retrieves a list of all chats associated with the account.

```APIDOC
## GET /accounts/{accountId}/chats

### Description
Retrieves a list of all chats associated with the specified account.

### Method
GET

### Endpoint
`/accounts/{accountId}/chats`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account to retrieve chats for.

### Response
#### Success Response (200)
- **chats** (array) - A list of chat objects, each containing chat information.
  - **chatId** (string) - The unique identifier for the chat.
  - **name** (string) - The name of the chat participant or group.

#### Response Example
```json
{
  "chats": [
    {
      "chatId": "chat123",
      "name": "John Doe"
    },
    {
      "chatId": "chat456",
      "name": "Family Group"
    }
  ]
}
```
```

--------------------------------

### Flask Webhook for Wildcat Integration

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

A Flask application setup to receive webhook notifications from Wildcat and to register its own webhook endpoint. It demonstrates how to process incoming messages, send auto-replies, and register a webhook URL with the Wildcat service. Requires Flask and requests libraries.

```python
from flask import Flask, request, jsonify
import requests

app = Flask(__name__)

WILDCAT_URL = "http://localhost:3000"

@app.route('/webhooks/whatsapp', methods=['POST'])
def webhook():
    data = request.json
    sender = data.get('from')
    text = data.get('text')

    print(f"Message from {sender}: {text}")

    # Send auto-reply
    response = requests.post(
        f"{WILDCAT_URL}/accounts/mybot/message/send",
        json={
            "to": sender,
            "message": f"I received your message: {text}"
        }
    )

    return jsonify({"ok": True})

@app.route('/register-webhook', methods=['POST'])
def register_webhook():
    # Register webhook in WILDCAT
    response = requests.post(
        f"{WILDCAT_URL}/webhooks",
        json={"url": "https://your-app.com/webhooks/whatsapp"}
    )
    return jsonify(response.json())

if __name__ == '__main__':
    app.run(port=3001)

```

--------------------------------

### Nginx Configuration for Security

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Example Nginx configuration to add basic authentication when exposing the API to the internet.

```APIDOC
## Nginx Reverse Proxy with Basic Authentication

### Description
This configuration demonstrates how to set up Nginx as a reverse proxy to an application running on `localhost:3000`, while adding basic HTTP authentication to restrict access.

### Method
N/A (Nginx Configuration)

### Endpoint
N/A

### Configuration Example
Add the following block to your Nginx server configuration file (e.g., `/etc/nginx/sites-available/default`):

```nginx
location / {
  auth_basic "Restricted";
  auth_basic_user_file /etc/nginx/.htpasswd;
  proxy_pass http://localhost:3000;
}
```

**Explanation:**
- `auth_basic "Restricted";`: Enables basic authentication and sets the realm name displayed in the login prompt.
- `auth_basic_user_file /etc/nginx/.htpasswd;`: Specifies the path to the file containing user credentials. You'll need to create this file using tools like `htpasswd` (e.g., `htpasswd -c /etc/nginx/.htpasswd username`).
- `proxy_pass http://localhost:3000;`: Forwards incoming requests to the application running on port 3000.
```

--------------------------------

### POST /webhooks

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Registers a webhook URL to receive incoming messages and events.

```APIDOC
## POST /webhooks

### Description
Registers a URL to receive real-time notifications from Wildcat for incoming messages and other events.

### Method
POST

### Endpoint
`/webhooks`

### Parameters
#### Request Body
- **url** (string) - Required - The URL to which Wildcat should send webhook notifications.

### Request Example
```json
{
  "url": "https://your-app.com/webhooks/whatsapp"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the webhook was registered.

#### Response Example
```json
{
  "message": "Webhook registered successfully."
}
```
```

--------------------------------

### Accounts Management: Create, List, Get Details (curl)

Source: https://notoriousarnav.github.io/wildcat/docs/api/endpoints

Manages WhatsApp accounts in WILDCAT. Create via POST /accounts with id (required), name, and optional collectionName. List via GET /accounts. Get details via GET /accounts/:accountId. Response includes status (connecting, connected, reconnecting, logged_out, not_started), hasQR flag, and timestamps. Errors: 400 for validation (e.g., missing id or duplicate), 404 if account not found. After creation, scan the displayed QR code to authenticate.

```bash
// Create Account
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "mybot",
    "name": "My WhatsApp Bot",
    "collectionName": "auth_mybot"
  }'

// Response (201 Created)
{
  "ok": true,
  "account": {
    "_id": "mybot",
    "name": "My WhatsApp Bot",
    "collectionName": "auth_mybot",
    "status": "connecting",
    "createdAt": "2025-11-08T12:30:45.123Z"
  }
}

// List All Accounts
curl http://localhost:3000/accounts

// Response (200 OK)
{
  "ok": true,
  "accounts": [
    {
      "_id": "mybot",
      "name": "My WhatsApp Bot",
      "collectionName": "auth_mybot",
      "status": "connected",
      "currentStatus": "connected",
      "hasQR": false,
      "createdAt": "2025-11-08T12:30:45.123Z"
    },
    {
      "_id": "support-bot",
      "name": "Support Bot",
      "status": "connecting",
      "currentStatus": "connecting",
      "hasQR": true,
      "createdAt": "2025-11-08T12:31:00.123Z"
    }
  ]
}

// Get Account Details
curl http://localhost:3000/accounts/mybot

// Response (200 OK)
{
  "ok": true,
  "account": {
    "_id": "mybot",
    "name": "My WhatsApp Bot",
    "collectionName": "auth_mybot",
    "status": "connected",
    "currentStatus": "connected",
    "hasQR": false,
    "createdAt": "2025-11-08T12:30:45.123Z"
  }
}

```

--------------------------------

### Configure WILDCAT Environment Variables

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

Sets essential configuration variables for the WILDCAT application, including host, port, MongoDB connection URL, database name, and Node environment. This file is read by the application at runtime.

```properties
HOST=0.0.0.0
PORT=3000
MONGO_URL=mongodb://localhost:27017
DB_NAME=wildcat
NODE_ENV=production

```

--------------------------------

### Utilize Environment Variables

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Store sensitive information like API keys and URLs in environment variables instead of hardcoding them. This enhances security and flexibility.

```javascript
const WILDCAT_URL = process.env.WILDCAT_URL;
const API_KEY = process.env.API_KEY;
```

--------------------------------

### POST /accounts/{accountId}/message/reply

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Replies to a specific message within a chat.

```APIDOC
## POST /accounts/{accountId}/message/reply

### Description
Replies to a specific message. This is useful for quoting a previous message in the conversation.

### Method
POST

### Endpoint
`/accounts/{accountId}/message/reply`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account to send the reply from.

#### Request Body
- **to** (string) - Required - The recipient's identifier.
- **message** (string) - Required - The content of the reply message.
- **quotedMessageId** (string) - Required - The ID of the message being replied to.
- **chatId** (string) - Required - The ID of the chat where the original message was sent.

### Request Example
```json
{
  "to": "919876543210@s.whatsapp.net",
  "message": "This is a reply to your message.",
  "quotedMessageId": "some_message_id",
  "chatId": "chat123"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the reply message sending operation.
- **messageId** (string) - The unique identifier for the sent reply message.

#### Response Example
```json
{
  "status": "sent",
  "messageId": "reply_message_id"
}
```
```

--------------------------------

### POST /accounts/{accountId}/message/send/image

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Sends an image message with an optional caption to a specified recipient.

```APIDOC
## POST /accounts/{accountId}/message/send/image

### Description
Sends an image message along with an optional caption to a specified recipient.

### Method
POST

### Endpoint
`/accounts/{accountId}/message/send/image`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account to send the message from.

#### Request Body
- **to** (string) - Required - The recipient's identifier.
- **imageBuffer** (Buffer/File) - Required - The image data to send.
- **caption** (string) - Optional - A caption for the image.

### Request Example
```json
{
  "to": "919876543210@s.whatsapp.net",
  "imageBuffer": "<image_binary_data>",
  "caption": "A beautiful image"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the message sending operation.
- **messageId** (string) - The unique identifier for the sent message.

#### Response Example
```json
{
  "status": "sent",
  "messageId": "some_image_message_id"
}
```
```

--------------------------------

### Express.js Webhook Receiver with WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Creates an Express server that receives WhatsApp webhooks, logs incoming messages, sends auto-replies via WILDCAT, and registers its public URL as a webhook on startup.

```javascript
const express = require('express');
const axios = require('axios');

const app = express();
app.use(express.json());

const WILDCAT_URL = 'http://localhost:3000';

// Webhook endpoint to receive messages
app.post('/webhooks/whatsapp', async (req, res) => {
  const { from, text, messageId } = req.body;

  console.log(`Message from ${from}: ${text}`);

  // Send auto-reply
  try {
    await axios.post(
      `${WILDCAT_URL}/accounts/mybot/message/send`,
      {
        to: from,
        message: 'Thanks for your message! I received it at ' + new Date().toLocaleTimeString()
      }
    );
  } catch (error) {
    console.error('Failed to send reply:', error.message);
  }

  res.json({ ok: true });
});

// Register webhook
async function registerWebhook() {
  try {
    await axios.post(
      `${WILDCAT_URL}/webhooks`,
      { url: 'https://your-app.com/webhooks/whatsapp' }
    );
    console.log('Webhook registered!');
  } catch (error) {
    console.error('Failed to register webhook:', error.message);
  }
}

app.listen(3001, async () => {
  console.log('App listening on port 3001');
  await registerWebhook();
});
```

--------------------------------

### Development Server Logging (Shell)

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

This command starts the Wildcat development server. All logs, including informational messages and errors, will be displayed directly in the terminal where the command is executed. This is useful for real-time debugging during development.

```shell
npm run dev

```

--------------------------------

### Node.js Version Check and Upgrade with NVM

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Checks current Node.js version and upgrades to 18+ using NVM if needed. NVM must be installed beforehand. Purpose is to ensure compatibility; outputs version number or installs/updates Node.

```bash
node --version

# If you have Node 16, upgrade:
# Using NVM (recommended)
nvm install 18
nvm use 18
```

--------------------------------

### Register Zapier Webhook in WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Registers a Zapier catch hook URL in WILDCAT via a POST request. Returns success confirmation or errors if registration fails.

```bash
curl -X POST http://localhost:3000/webhooks \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://hooks.zapier.com/hooks/catch/YOUR-WEBHOOK-ID/..."
  }'
```

--------------------------------

### Batch Messages for Parallel Sending

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Improve efficiency by sending multiple messages concurrently using `Promise.all`. This method maps over phone numbers and initiates parallel send operations.

```javascript
// Send multiple messages in parallel
await Promise.all(
  phoneNumbers.map(phone =>
    client.send(phone, 'Your message')
  )
);
```

--------------------------------

### Cache Data for Performance

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Optimize data retrieval by implementing a caching strategy. This function fetches chats and caches them for a defined duration (5 minutes) to reduce redundant API calls.

```javascript
// Cache chats for 5 minutes
const cacheTime = 5 * 60 * 1000;
let cachedChats = null;
let cacheExpiry = null;

async function getChatsWithCache() {
  if (cachedChats && Date.now() < cacheExpiry) {
    return cachedChats;
  }
  cachedChats = await client.getChats();
  cacheExpiry = Date.now() + cacheTime;
  return cachedChats;
}
```

--------------------------------

### Verify Server and Database Connection

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Commands to verify that the server is running, the database is connected, and test accounts can be created.

```bash
curl http://localhost:3000/ping
```

```bash
mongosh
> show databases
> use wildcat
> show collections
```

```bash
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"test","name":"Test Account"}'
```

--------------------------------

### GET /accounts/{accountId}/chats/{chatId}/messages

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Retrieves messages from a specific chat, with an option to limit the number of results.

```APIDOC
## GET /accounts/{accountId}/chats/{chatId}/messages

### Description
Retrieves messages from a specific chat. You can limit the number of messages returned.

### Method
GET

### Endpoint
`/accounts/{accountId}/chats/{chatId}/messages`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account.
- **chatId** (string) - Required - The ID of the chat to retrieve messages from.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of messages to retrieve. Defaults to 50.

### Response
#### Success Response (200)
- **messages** (array) - A list of message objects.
  - **messageId** (string) - The unique identifier for the message.
  - **sender** (string) - The identifier of the message sender.
  - **text** (string) - The content of the message.
  - **timestamp** (integer) - The timestamp when the message was sent.

#### Response Example
```json
{
  "messages": [
    {
      "messageId": "msg1",
      "sender": "919876543210@s.whatsapp.net",
      "text": "Hello there!",
      "timestamp": 1678886400
    }
  ]
}
```
```

--------------------------------

### Deploy with Systemd on Linux

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Configures WILDCAT as a Systemd service for automatic startup and management on Linux systems.

```bash
sudo systemctl daemon-reload
sudo systemctl enable wildcat
sudo systemctl start wildcat
sudo systemctl status wildcat
```

--------------------------------

### Creating a WILDCAT Account via API

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Uses curl to POST account creation to the local server, generating a QR code in terminal for WhatsApp linking. Server must be running on localhost:3000; requires JSON payload with id and name. Outputs QR in server logs; fails if ID exists.

```bash
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"test","name":"Test"}'
   
# QR should appear in server terminal within 10 seconds
```

```bash
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"mybot"}'

# Solution: Use a unique ID
curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"mybot2"}'
```

--------------------------------

### Server Configuration

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Instructions for configuring server settings, including increasing heap size for better performance.

```APIDOC
## Server Heap Size Configuration

### Description
Instructions on how to increase the Node.js heap size to improve server performance, especially when dealing with heavy loads.

### Method
N/A (Environment Variable/Command Line)

### Endpoint
N/A

### Usage
To increase the maximum old space size for Node.js applications, use the `NODE_OPTIONS` environment variable.

### Command Example
```bash
NODE_OPTIONS=--max-old-space-size=2048 npm start
```

This command starts the `npm start` script with the heap size limit set to 2048MB (2GB).
```

--------------------------------

### WhatsApp JID Examples

Source: https://notoriousarnav.github.io/wildcat/docs/api

Provides examples of WhatsApp JIDs (Java IDs), which are used to identify individual users and groups within the WhatsApp network. These IDs are crucial for targeting messages and managing chats.

```text
Individual:
919876543210@s.whatsapp.net

Group:
123456789-1234567890@g.us

```

--------------------------------

### Perform Health Check via GET /ping (curl)

Source: https://notoriousarnav.github.io/wildcat/docs/api/endpoints

Verifies server availability and responsiveness. GET request to /ping. Expected response: 200 OK with ok: true, pong: true, and a time field. No authentication required.

```bash
curl http://localhost:3000/ping

// Response (200 OK)
{
  "ok": true,
  "pong": true,
  "time": "2025-11-08T12:30:45.123Z"
}

```

--------------------------------

### Node.js Axios Timeout Configuration

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

A JavaScript example showing how to configure a custom timeout for Axios HTTP requests in a Node.js environment. This is useful for preventing requests from hanging indefinitely, especially for operations that might take longer to complete.

```javascript
const client = axios.create({
  timeout: 30000  // 30 seconds
});

```

--------------------------------

### Troubleshoot Port and MongoDB Issues

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Commands to troubleshoot common issues like port conflicts, MongoDB connection failures, and permission errors.

```bash
lsof -i :3000
kill -9 <PID>
```

```bash
mongosh
brew services start mongodb-community  # macOS
sudo systemctl start mongod            # Linux
```

```bash
sudo npm start
sudo chown -R $USER:$USER /path/to/wildcat
```

```bash
NODE_OPTIONS=--max-old-space-size=2048 npm start
```

--------------------------------

### GET /accounts/:accountId/status

Source: https://notoriousarnav.github.io/wildcat/docs/api/endpoints

Retrieves the current connection status of a specified account.

```APIDOC
## GET /accounts/:accountId/status

### Description
Check current connection status of an account.

### Method
GET

### Endpoint
`/accounts/:accountId/status`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier of the account.

### Response
#### Success Response (200 OK)
- **ok** (boolean) - Indicates if the request was successful.
- **status** (string) - The current connection status (e.g., "connected").
- **accountId** (string) - The identifier of the account.
- **lastUpdate** (string) - The timestamp of the last status update in ISO 8601 format.

#### Response Example
```json
{
  "ok": true,
  "status": "connected",
  "accountId": "mybot",
  "lastUpdate": "2025-11-08T12:30:45.123Z"
}
```
```

--------------------------------

### Create Docker Compose Configuration for WILDCAT

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet defines a docker-compose.yml file with services for MongoDB and WILDCAT, including volumes, ports, and environment variables. It depends on Docker Compose, with no inputs. Outputs include a configured file for orchestration; limitations are tied to Docker engine requirements and environment variable correctness.

```yaml
version: '3.8'

services:
  mongodb:
    image: mongo:6.0
    container_name: wildcat-mongo
    ports:
      - "27017:27017"
    volumes:
      - mongodb_data:/data/db
    environment:
      MONGO_INITDB_DATABASE: wildcat
    restart: unless-stopped

  wildcat:
    build: .
    container_name: wildcat-app
    ports:
      - "3000:3000"
    environment:
      HOST: 0.0.0.0
      PORT: 3000
      MONGO_URL: mongodb://mongodb:27017
      DB_NAME: wildcat
      NODE_ENV: production
    depends_on:
      - mongodb
    restart: unless-stopped
    volumes:
      - ./logs:/app/logs

volumes:
  mongodb_data:

```

--------------------------------

### Logging and Debugging

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Information on how to view server logs for debugging purposes.

```APIDOC
## Viewing Server Logs

### Description
Provides commands to view server logs, both during development and in production environments using PM2, as well as instructions for checking MongoDB logs.

### Method
N/A (Command Line)

### Endpoint
N/A

### Commands
**Development Logs:**
Run your development server using:
```bash
npm run dev
```
All logs will be displayed directly in the terminal.

**Production Logs (with PM2):**
To view logs for a process managed by PM2 (assuming your application is named 'wildcat'):
```bash
pm2 logs wildcat
pm2 logs wildcat --err
```
The `--err` flag shows only error logs.

**MongoDB Logs:**
Connect to MongoDB using `mongosh` and then run queries to inspect collections like `accounts` and `messages`.
```bash
mongosh

// Example queries:
test> db.getCollection("accounts").find()
test> db.getCollection("messages").findOne()
```
```

--------------------------------

### POST /accounts/{accountId}/message/send

Source: https://notoriousarnav.github.io/wildcat/docs/guides/integration-examples

Sends a text message to a specified recipient.

```APIDOC
## POST /accounts/{accountId}/message/send

### Description
Sends a text message to a specified recipient using the Wildcat API.

### Method
POST

### Endpoint
`/accounts/{accountId}/message/send`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account to send the message from.

#### Request Body
- **to** (string) - Required - The recipient's identifier (e.g., phone number with WhatsApp format).
- **message** (string) - Required - The content of the message to send.

### Request Example
```json
{
  "to": "919876543210@s.whatsapp.net",
  "message": "Hello!"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the message sending operation.
- **messageId** (string) - The unique identifier for the sent message.

#### Response Example
```json
{
  "status": "sent",
  "messageId": "some_message_id"
}
```
```

--------------------------------

### GET /accounts

Source: https://notoriousarnav.github.io/wildcat/docs/api

Retrieves a list of all registered WhatsApp accounts with their current connection status.

```APIDOC
## GET /accounts

### Description
Retrieves a list of all registered WhatsApp accounts

### Method
GET

### Endpoint
/accounts

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates successful response
- **data** (array) - List of account objects

#### Response Example
```
{
  "ok": true,
  "data": [
    {
      "id": "mybot",
      "status": "connected"
    }
  ]
}
```
```

--------------------------------

### Testing Internet Connectivity

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Simple curl check to verify internet access, useful for disconnection issues. No dependencies beyond curl; outputs HTML if successful. Limitation: Only tests WhatsApp site, not full connectivity.

```bash
curl https://www.whatsapp.com
```

--------------------------------

### Verify WILDCAT Deployment Status

Source: https://notoriousarnav.github.io/wildcat/docs/guides/deployment

This snippet checks the status of Nginx, PM2, and MongoDB services, and tests the API endpoint. It depends on systemctl, PM2 CLI, and curl, with no inputs required. Outputs include service statuses and API responses; limitations may arise if services are not running or endpoints are incorrect.

```shell
# Check Nginx is running
sudo systemctl status nginx

# Check PM2 is running
pm2 status

# Check MongoDB is running
sudo systemctl status mongod

# Test API
curl https://your-domain.com/ping
```

--------------------------------

### Configure Nginx Reverse Proxy

Source: https://notoriousarnav.github.io/wildcat/docs/getting-started/installation

Sets up Nginx as a reverse proxy for the WILDCAT API, enabling access via a domain name.

```bash
sudo ln -s /etc/nginx/sites-available/wildcat /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx
```

--------------------------------

### Port Configuration

Source: https://notoriousarnav.github.io/wildcat/docs/troubleshooting/faq

Details on the ports WILDCAT uses and how to configure them.

```APIDOC
## Port Configuration

### Description
WILDCAT uses port 3000 by default, which can be changed using the `PORT` environment variable. This section explains how to check and modify the port.

### Method
Environment Variable / Shell Command

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### POST /accounts/create

Source: https://notoriousarnav.github.io/wildcat/docs/ARCHITECTURE

Creates a new WhatsApp account session. This endpoint initializes the account creation flow which generates a QR code for authentication via WhatsApp mobile app.

```APIDOC
## POST /accounts/create

### Description
Initiates the creation of a new WhatsApp account session and generates a QR code for authentication.

### Method
POST

### Endpoint
/accounts/create

### Parameters
#### Request Body
- **accountId** (string) - Optional - Unique identifier for the account. If not provided, a random ID will be generated.

### Request Example
{
  "accountId": "myaccount"
}

### Response
#### Success Response (200)
- **qrCode** (string) - Base64 encoded QR code image for WhatsApp authentication
- **accountId** (string) - Identifier for the created account

#### Response Example
{
  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAACCCAMAAADQNkiAAAAA1BMVEW10NBjBBbqAAAAR0lEQVRo3u3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIBLcQ8AAa0jZQAAAABJRU5ErkJggg==",
  "accountId": "myaccount"
}
```

--------------------------------

### GET /accounts/:accountId

Source: https://notoriousarnav.github.io/wildcat/docs/api

Retrieves detailed information about a specific WhatsApp account including connection status and configuration.

```APIDOC
## GET /accounts/:accountId

### Description
Retrieves detailed information about a specific WhatsApp account

### Method
GET

### Endpoint
/accounts/:accountId

### Path Parameters
- **accountId** (string) - Required - Unique identifier of the account

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates successful response
- **data** (object) - Account details

#### Response Example
```
{
  "ok": true,
  "data": {
    "id": "mybot",
    "status": "connected",
    "created_at": 1730700645123
  }
}
```
```
Tokens:
Raw