# Deploy Velix API with Easypanel

URL: /templates/velix-api

Velix is a self-hosted WhatsApp API built in Go. Connect multiple WhatsApp numbers, send and receive messages via REST, get real-time webhooks, and integrate with n8n and Chatwoot out of the box. It features a web-based admin panel for managing instances, QR code pairing, per-instance API keys, and automatic media download with local storage. Designed for agencies and developers who need reliable WhatsApp automation at scale.

## Installation notes

After deployment, open the admin panel at your domain to register your first
account. Then create a WhatsApp instance and scan the QR code to connect your
phone number. Each instance gets its own API key for secure access.


## Benefits

### Multi-Instance WhatsApp

Run up to 200 WhatsApp connections from a single server. Each instance is isolated with its own API key, webhook settings, and QR code pairing.

### Full REST API

Send text, images, audio, video, documents, locations, contacts, reactions, and polls through a clean REST API with OpenAPI documentation.

### Real-Time Webhooks

Receive events in real time with HMAC-SHA256 signing, automatic retry with exponential backoff, and per-instance event filtering.

### n8n and Chatwoot Integration

Community node for n8n workflow automation (including AI Agent tool) and built-in Chatwoot integration for customer support with history sync.

## Features

### Admin Panel

Web-based dashboard for managing instances, viewing connection status, configuring webhooks, and generating API keys.

### Per-Instance API Keys

Each WhatsApp instance gets its own scoped API key. Keys are generated from the admin panel and can be rotated at any time.

### QR Code Pairing

Connect WhatsApp via QR code or pair code directly from the admin panel with real-time SSE streaming.

### Media Storage

Automatic media download from WhatsApp CDN with local storage and REST endpoints for retrieval. Optional base64 encoding in webhook payloads.

### Chatwoot Integration

Route WhatsApp messages to Chatwoot inboxes with automatic contact creation, conversation management, and full history sync.

### Human Pause

When an agent replies manually, bot automation is paused for a configurable period so humans and bots can coexist seamlessly.

## Configuration

- `appServiceName` (App Service Name, required): velix-api

- `appServiceImage` (App Service Image, required): ghcr.io/paulolinder/velix-api:0.1.0

- `databaseServiceName` (Database Service Name, required): velix-db

- `redisServiceName` (Redis Service Name, required): velix-redis

## Services

- velix-api: app (ghcr.io/paulolinder/velix-api:0.1.0)

- velix-db: postgres

- velix-redis: redis

## Resources

- [Website](https://velix.dev)

- [Documentation](https://github.com/paulolinder/velix-api)

- [Github](https://github.com/paulolinder/velix-api)

- [Template source](https://github.com/easypanel-io/templates/tree/main/templates/velix-api)