← 返回首页
GitHub - evolution-foundation/evolution-go: Evolution API / Evolution Go is an open-source WhatsApp integration API · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

evolution-foundation/evolution-go

 main
BranchesTags
Go to file
Code

Repository files navigation

Evolution Go

High-performance WhatsApp API built in Go — part of the Evolution Foundation ecosystem.

Website · Documentation · Community · Support

About

Evolution Go is a high-performance WhatsApp API built in Go. Part of the Evolution Foundation ecosystem, it provides a robust, lightweight solution for WhatsApp integration using the whatsmeow library.

Part of the Evolution Foundation ecosystem

Evolution Go is one of the messaging engines maintained by Evolution Foundation. It is used as a WhatsApp provider by the Evo CRM Community and other projects in the ecosystem.

Features

  • High performance — built with Go for minimal resource usage
  • RESTful API — clean, well-documented REST endpoints with Swagger
  • Real-time events — WebSocket, Webhook, AMQP/RabbitMQ and NATS support
  • Media support — images, videos, audio, documents with MinIO/S3 storage
  • Message storage — optional PostgreSQL persistence
  • QR code pairing — built-in QR code generation for device linking
  • License management — built-in licensing with registration, activation, and heartbeat
  • Docker ready — production-ready Docker configuration

Quick Start

Docker (recommended)

git clone https://github.com/evolution-foundation/evolution-go.git cd evolution-go make docker-build make docker-run

Local development

git clone https://github.com/evolution-foundation/evolution-go.git cd evolution-go # Clone whatsmeow dependency git clone git@github.com:evolution-foundation/whatsmeow.git whatsmeow-lib # Setup, configure and run make setup cp .env.example .env make dev

Run make help to see all available commands. See COMMANDS.md for detailed workflows.

Configuration

Create a .env file:

# Server SERVER_PORT=8080 CLIENT_NAME=evolution # Security GLOBAL_API_KEY=your-secure-api-key-here # Database POSTGRES_AUTH_DB=postgresql://postgres:password@localhost:5432/evogo_auth?sslmode=disable POSTGRES_USERS_DB=postgresql://postgres:password@localhost:5432/evogo_users?sslmode=disable DATABASE_SAVE_MESSAGES=false # Logging WADEBUG=DEBUG LOGTYPE=console # Optional # AMQP_URL=amqp://guest:guest@localhost:5672/ # NATS_URL=nats://localhost:4222 # WEBHOOK_URL=https://your-webhook-url.com/webhook # MINIO_ENABLED=true # MINIO_ENDPOINT=localhost:9000 # MINIO_ACCESS_KEY=minioadmin # MINIO_SECRET_KEY=minioadmin
Variable Description Default
SERVER_PORT Server port 8080
CLIENT_NAME Client identifier evolution
GLOBAL_API_KEY API authentication key Required
DATABASE_SAVE_MESSAGES Enable message storage false
WADEBUG WhatsApp debug level INFO

License Activation

Evolution Go requires a license to operate. On first run:

  1. Start the server — API endpoints return 503 until activated
  2. Open the Manager at http://localhost:8080/manager/login
  3. Enter your API URL and GLOBAL_API_KEY
  4. Complete the license registration flow
  5. Once activated, the API is fully operational

The license status persists in the database (runtime_configs table). Heartbeats are sent periodically to maintain activation.

API Documentation

Swagger UI available at:

http://localhost:8080/swagger/index.html

Key Endpoints

Method Endpoint Description
POST /instance/create Create WhatsApp instance
GET /instance/{name}/qrcode Get QR code for pairing
POST /message/sendText Send text message
POST /message/sendMedia Send media message
GET /instance/{name}/status Get instance status
DELETE /instance/{name} Delete instance

Project Structure

evolution-go/ ├── cmd/evolution-go/ # Application entry point ├── pkg/ │ ├── core/ # License management & middleware │ ├── instance/ # Instance management │ ├── message/ # Message handling │ ├── sendMessage/ # Message sending │ ├── routes/ # HTTP routes │ ├── middleware/ # Auth & validation middleware │ ├── config/ # Configuration │ ├── events/ # Event producers (AMQP, NATS, Webhook, WS) │ └── storage/ # Media storage (MinIO) ├── whatsmeow-lib/ # WhatsApp protocol library ├── docs/ # Swagger documentation ├── Dockerfile ├── Makefile └── VERSION

Tech Stack

Component Technology
Language Go 1.24+
HTTP framework Gin
WhatsApp whatsmeow
Database PostgreSQL
ORM GORM
Message queue RabbitMQ, NATS
Object storage MinIO/S3
Documentation Swagger/OpenAPI
Container Docker

Documentation

Resource Link
Website evolutionfoundation.com.br
Documentation docs.evolutionfoundation.com.br
Community evolutionfoundation.com.br/community
Docker Hub evoapicloud/evolution-go
Changelog CHANGELOG.md
Contributing CONTRIBUTING.md
Security SECURITY.md

Hosting

Deploy Evolution Go with optimized infrastructure through our HostGator partnership:

Evolution Go VPS — HostGator

Telemetry

Evolution Go collects anonymous telemetry data (routes used, API version) to help improve the service. No sensitive or personal data is collected.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to submit issues, propose features, and open pull requests.

Join our community to discuss ideas and collaborate.

Security

For security issues, do not open a public issue. Email suporte@evofoundation.com.br or use GitHub's private vulnerability reporting. See SECURITY.md for details.

Acknowledgments

License

Evolution Go is licensed under the Apache License 2.0, with additional brand-protection conditions (LOGO/copyright preservation and Usage Notification requirement). See LICENSE for full details.

For licensing inquiries, contact suporte@evofoundation.com.br.

Trademarks

"Evolution Foundation", "Evolution" and "Evolution Go" are trademarks of Evolution Foundation. See TRADEMARKS.md for the brand assets policy.

Third-party attributions are documented in NOTICE.

Made by Evolution Foundation · © 2026

About

Evolution API / Evolution Go is an open-source WhatsApp integration API

evolutionfoundation.com.br

Topics

golang evolution whatsapp whatsapp-bot cloud-api baileys whatsmeow evolution-api evolution-go evo-api evo-go

Resources

Readme

License

View license
Activity
Custom properties

Stars

346 stars

Watchers

7 watching

Forks

178 forks
Report repository

Releases 1

v0.7.0 Latest
Apr 17, 2026

Packages

 
 
 

Contributors

Languages

Footer

© 2026 GitHub, Inc.