evolution-api  by EvolutionAPI

Open-source API for WhatsApp integration and multiple messaging services

created 2 years ago
4,640 stars

Top 10.8% on sourcepulse

GitHubView on GitHub
Project Summary

Evolution API provides a robust, RESTful interface for integrating with WhatsApp and other messaging platforms, targeting developers and businesses seeking to automate communication. It offers flexibility through multiple connection types and extensive integrations with AI, CRM, and queuing systems, simplifying complex messaging workflows.

How It Works

Evolution API acts as a middleware, abstracting the complexities of underlying messaging protocols into a unified REST API. It supports two primary WhatsApp connection methods: Baileys (WhatsApp Web-based, free) and the official WhatsApp Cloud API (Meta-provided, potentially paid). This dual approach allows users to choose between cost-effectiveness and official, scalable solutions. Integrations with services like OpenAI, Dify, Chatwoot, and message queues (RabbitMQ, SQS) enable advanced features such as AI-powered responses, CRM integration, and event-driven architectures.

Quick Start & Requirements

  • Install/Run: Docker is the primary method. A docker-compose.yml is provided.
  • Prerequisites: Docker, Docker Compose. For WhatsApp Cloud API, a Meta Developer account and app setup are required. For Baileys, no specific prerequisites beyond Docker are mentioned.
  • Resources: No specific resource estimates are provided, but Docker implies a standard containerized environment.
  • Links: Documentation, Postman Collection, Discord Community.

Highlighted Details

  • Supports both Baileys (WhatsApp Web) and official WhatsApp Cloud API.
  • Integrates with Typebot, Chatwoot, Dify, OpenAI, RabbitMQ, SQS, Socket.io, Amazon S3/Minio.
  • Offers a "Lite" version for performance-optimized microservices.
  • Includes telemetry for service improvement (non-sensitive data collection).

Maintenance & Community

The project is actively maintained by EvolutionAPI and has a Discord community for support. Sponsorships and content creator partnerships are highlighted, indicating community engagement.

Licensing & Compatibility

Licensed under Apache License 2.0 with specific conditions: frontend logo/copyright must remain, and usage must be notified in projects (including closed-source). Failure to comply may require a commercial license. Contact contato@atendai.com for licensing inquiries.

Limitations & Caveats

The Baileys connection method relies on WhatsApp Web and may have limitations compared to official APIs. The frontend logo/copyright restriction and the mandatory usage notification requirement for all projects could impact integration into closed-source or branded applications without a commercial license.

Health Check
Last commit

5 days ago

Responsiveness

1 week

Pull Requests (30d)
34
Issues (30d)
74
Star History
1,354 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.