Evolution API Installation

This guide will help you install and configure Evolution API, our main REST API for WhatsApp integration.

Prerequisites

Before starting, set up the required infrastructure services:

Database

PostgreSQL or MySQL with Prisma ORM

Redis

Distributed cache for high performance

Installation Methods

Choose the method that best suits your scenario:

Docker

Recommended for production. Includes standalone Docker Compose and Docker Swarm with Traefik for high availability.

NVM

Local installation with Node Version Manager. Ideal for development or when you need full control over the environment.

Nginx & SSL

Reverse proxy configuration with Nginx and SSL certificate via Let’s Encrypt.

SetupOrion

Automated installer with Traefik, Portainer and Docker Swarm. Ideal for a clean VPS.

Quick Verification

After installing with any method, verify the API is working:

Health check

curl http://localhost:8080/

Create your first WhatsApp instance

curl -X POST http://localhost:8080/instance/create \
  -H "Content-Type: application/json" \
  -H "apikey: your-secure-key-here" \
  -d '{
    "instanceName": "my-instance",
    "integration": "WHATSAPP-BAILEYS",
    "qrcode": true
  }'

Get the QR Code to connect

curl http://localhost:8080/instance/connect/my-instance \
  -H "apikey: your-secure-key-here"

Scan the QR Code with your phone’s WhatsApp to connect the instance.

Check connection status

curl http://localhost:8080/instance/connectionState/my-instance \
  -H "apikey: your-secure-key-here"

Next Steps

Environment Variables

Complete reference of all configuration variables

Webhooks

Set up webhooks to receive real-time events

Integrations

Connect with Chatwoot, Typebot, OpenAI, Dify and more

Updates

Keep your instance always up to date

Getting Started

Configuration

Integrations

Prerequisites

Database

Redis

Installation Methods

Docker

NVM

Nginx & SSL

SetupOrion

Quick Verification

Health check

Create your first WhatsApp instance

Get the QR Code to connect

Check connection status

Next Steps

Environment Variables

Webhooks

Integrations

Updates

​Prerequisites

Database

Redis

​Installation Methods

Docker

NVM

Nginx & SSL

SetupOrion

​Quick Verification

​Health check

​Create your first WhatsApp instance

​Get the QR Code to connect

​Check connection status

​Next Steps

Environment Variables

Webhooks

Integrations

Updates

Prerequisites

Installation Methods

Quick Verification

Health check

Create your first WhatsApp instance

Get the QR Code to connect

Check connection status

Next Steps