@rjsebening/n8n-nodes-evolution-api 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.DE.md

@@ -0,0 +1,231 @@
+# n8n-nodes-evolution-api
+
+![Evolution API Node](https://img.shields.io/badge/n8n-community--node-FF6D5A)
+![Version](https://img.shields.io/badge/version-1.0.0-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+
+Ein professioneller **n8n Community Node** zur Integration der **Evolution API**.
+Automatisiere WhatsApp-bezogene Prozesse wie Nachrichtenversand, Gruppenverwaltung und Instanz-Steuerung – vollständig API-basiert und produktionsreif.
+
+---
+
+## Was ist n8n?
+
+n8n ist ein leistungsfähiges Workflow-Automatisierungstool, mit dem sich verschiedene Systeme und APIs miteinander verbinden lassen – unter anderem die Evolution API.
+
+Durch visuelle Workflows kannst du manuelle Prozesse automatisieren, Systeme koppeln und komplexe Abläufe zuverlässig abbilden – ohne eigene Backend-Logik entwickeln zu müssen.
+
+---
+
+## ⚖️ Rechtlicher Hinweis
+
+Dieser Community Node nutzt die **öffentliche Evolution API** und ist **nicht offiziell mit der Evolution API, deren Betreibern oder Maintainer:innen verbunden, unterstützt oder gesponsert**.
+
+Alle Marken, Namen und Logos gehören ihren jeweiligen Eigentümern.
+
+> **Hinweis:** Dies ist ein Community-Projekt. Für Support oder Fragen zur Evolution API selbst wende dich bitte an die offizielle Dokumentation bzw. die Maintainer.
+
+---
+
+## 🚀 Überblick
+
+Dieser n8n Node ermöglicht eine strukturierte und stabile Anbindung an die Evolution API.
+Der Fokus liegt auf **ausgehenden API-Aktionen**, also der aktiven Steuerung von WhatsApp-Instanzen und Nachrichten aus Automationen heraus.
+
+Ideal für:
+
+* Agenturen
+* interne Tools
+* Backend-Automatisierungen
+* operative WhatsApp-Workflows
+
+---
+
+## ✨ Zentrale Funktionen
+
+### 💬 **Nachrichten & Kommunikation**
+
+* **Textnachrichten senden**
+* **Medien versenden** (Bilder, Dokumente, Audio, Video)
+* **Umfragen & interaktive Nachrichten**
+* **Nachrichten an Gruppen senden**
+* **Antworten auf bestehende Chats**
+
+---
+
+### 👥 **Gruppen- & Chat-Verwaltung**
+
+* WhatsApp-Gruppen erstellen
+* Teilnehmer hinzufügen / entfernen
+* Gruppeninformationen aktualisieren
+* Chats abrufen
+* Gruppen-Metadaten laden
+
+---
+
+### 🧩 **Instanz-Verwaltung**
+
+* Instanzen auflisten
+* Verbindungsstatus prüfen
+* Instanzen neu starten
+* Instanzen ausloggen
+* QR-Codes abrufen
+
+---
+
+### 🔐 **Sichere API-Integration**
+
+* Authentifizierung per API-Key
+* Verbindungstest
+* Einheitliche Fehlerbehandlung
+* Reine JSON-Requests (kein proprietäres Format)
+
+---
+
+## 📦 Installation
+
+### Voraussetzungen
+
+* n8n Version **≥ 1.0.0**
+* ✅ Getestet mit **n8n 2.0**
+* Laufende Evolution API Instanz
+* Gültiger Evolution API Key
+
+---
+
+## 🔧 Installation in n8n
+
+Dieser Node wird über die **Community Nodes** in n8n installiert.
+
+1. Öffne deine n8n-Instanz
+2. Gehe zu **Einstellungen → Community Nodes → Installieren**
+3. Verwende folgenden Paketnamen:
+
+```
+@rjsebening/n8n-nodes-evolution-api
+```
+
+Der Node wird bewusst **scoped** veröffentlicht, um:
+
+* Namenskonflikte zu vermeiden
+* Community- und inoffizielle Nodes klar abzugrenzen
+* zukünftige offizielle Pakete nicht zu blockieren
+
+4. n8n neu starten → Node ist verfügbar
+
+---
+
+## 🔑 API-Zugang einrichten
+
+1. In n8n zu **Credentials → Neu erstellen**
+2. Nach **„Evolution API“** suchen
+3. Folgende Felder ausfüllen:
+
+   * **Server URL**
+     Basis-URL deiner Evolution API
+     *(z. B. `https://deine-evolution-api.domain`)*
+   * **API Key**
+     Dein persönlicher API-Key
+
+---
+
+### API-Key erhalten
+
+1. Evolution API Interface öffnen
+2. Zu **Settings / API** navigieren
+3. API-Key generieren oder kopieren
+4. In n8n hinterlegen
+
+---
+
+## ⚙️ Verfügbare Aktionen
+
+### **Nachrichten**
+
+| Aktion                 | Beschreibung                           |
+| ---------------------- | -------------------------------------- |
+| Textnachricht senden   | Versand einfacher WhatsApp-Nachrichten |
+| Mediennachricht senden | Bilder, Dokumente, Audio oder Video    |
+| Umfrage senden         | Interaktive Poll-Nachrichten           |
+| An Gruppe senden       | Nachrichten an WhatsApp-Gruppen        |
+
+---
+
+### **Chats & Gruppen**
+
+| Aktion                | Beschreibung                          |
+| --------------------- | ------------------------------------- |
+| Gruppe erstellen      | Neue WhatsApp-Gruppe anlegen          |
+| Gruppe aktualisieren  | Gruppenname oder Einstellungen ändern |
+| Teilnehmer hinzufügen | Nutzer zur Gruppe hinzufügen          |
+| Teilnehmer entfernen  | Nutzer aus Gruppe entfernen           |
+| Chats abrufen         | Chats einer Instanz laden             |
+| Gruppen abrufen       | Gruppeninformationen laden            |
+
+---
+
+### **Instanzen**
+
+| Aktion               | Beschreibung                 |
+| -------------------- | ---------------------------- |
+| Instanzen auflisten  | Alle verfügbaren Instanzen   |
+| Instanzstatus prüfen | Verbindungsstatus abrufen    |
+| Instanz neu starten  | WhatsApp-Instanz neu starten |
+| Instanz ausloggen    | Instanz abmelden             |
+| QR-Code abrufen      | QR-Code zur Anmeldung laden  |
+
+---
+
+### **Utilities**
+
+| Aktion                   | Beschreibung                 |
+| ------------------------ | ---------------------------- |
+| Authentifizierung testen | API-Key & Verbindung prüfen  |
+| Health-Check             | Server-Erreichbarkeit prüfen |
+
+---
+
+## 📖 Praxisbeispiele
+
+* WhatsApp-Benachrichtigungen bei Statusänderungen
+* Automatische Nachrichten nach Formular-Einreichungen
+* Interne Team-Alerts über WhatsApp
+* WhatsApp-Integration in ERP-, CRM- oder interne Systeme
+* Operative Steuerung mehrerer WhatsApp-Instanzen
+
+---
+
+## 🌍 Warum das wichtig ist
+
+WhatsApp ist in vielen Unternehmen geschäftskritisch – aber manuelle Prozesse skalieren nicht.
+
+Dieser Node ermöglicht:
+
+* zentrale Steuerung
+* automatisierte Kommunikation
+* weniger Fehler
+* saubere Backend-Integration
+
+Ohne eigene API-Clients oder Custom-Code.
+
+---
+
+## 👤 Über den Autor
+
+Ich bin **Rezk Jörg Sebening** – Business-Automation-Experte im DACH-Raum.
+Ich entwickle Automatisierungssysteme, skalierbare Workflows und n8n Community Nodes für Agenturen und wachsende Unternehmen.
+
+👉 GitHub-Profil folgen, um Updates und neue Integrationen nicht zu verpassen.
+
+---
+
+## 📋 Disclaimer
+
+Dies ist ein **inoffizieller Community Node** und **kein offizielles Produkt der Evolution API**.
+
+**Wichtige Hinweise:**
+
+* Der Node wird von der Community gepflegt
+* Verhalten und Features hängen von der Evolution-API-Version ab
+* Für API-Probleme bitte die offizielle Dokumentation konsultieren
+* Alle Marken und Logos gehören ihren jeweiligen Eigentümern

package/README.md

@@ -0,0 +1,220 @@
+# @rjsebening/n8n-nodes-evolution-api
+
+![Evolution API Node](https://img.shields.io/badge/n8n-community--node-FF6D5A)
+![Version](https://img.shields.io/badge/version-1.0.0-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+
+A professional n8n community node for seamless integration with the **Evolution API**.
+Automate WhatsApp-related operations like sending messages, managing instances, and interacting with chats and groups — fully API-driven and production-ready.
+
+---
+
+## What is n8n?
+
+n8n is an easy-to-use workflow automation tool that connects different apps and services, like the Evolution API.
+By creating workflows between systems, you can automate repetitive tasks and backend processes — saving time, reducing errors, and scaling operations reliably.
+
+---
+
+## ⚖️ Legal Notice
+
+This Community Node uses the public **Evolution API** and is **not affiliated with, endorsed, or sponsored by the Evolution API project or its maintainers**.
+All trademarks are the property of their respective owners.
+
+**Note**: This is a community-developed node. For official support regarding the Evolution API, please refer to the official documentation or maintainers.
+
+---
+
+## 🚀 Overview
+
+This n8n custom node provides a clean and structured integration with the Evolution API, enabling you to control WhatsApp instances and perform messaging-related actions programmatically.
+
+The focus of this node is **stable, outbound API interaction** — ideal for automation workflows, backend systems, and operational processes.
+
+---
+
+## ✨ Key Features
+
+### 💬 **Messaging & Communication**
+
+* **Send Message**: Send text messages via WhatsApp
+* **Send Media**: Send images, documents, audio, or video
+* **Send Polls & Interactive Messages**
+* **Send Messages to Groups**
+* **Reply to Existing Chats**
+
+---
+
+### 👥 **Group & Chat Management**
+
+* **Create Groups**
+* **Add / Remove Participants**
+* **Update Group Info**
+* **Fetch Chats**
+* **Fetch Group Metadata**
+
+---
+
+### 🧩 **Instance Management**
+
+* **List Instances**
+* **Get Instance Status**
+* **Restart / Logout Instances**
+* **QR Code Handling**
+* **Connection Status Checks**
+
+---
+
+### 🔐 **Secure API Integration**
+
+* **API Key Authentication**
+* **Connection Test**
+* **Consistent Error Handling**
+* **Fully JSON-based Requests**
+
+---
+
+## 📦 Installation
+
+### Requirements
+
+* n8n version **1.0.0 or higher**
+* ✅ testet with **n8n 2.0**
+* Running Evolution API instance
+* Valid Evolution API key
+
+---
+
+## 🔧 Configuration
+
+### Installation in n8n
+
+This node can be installed using the **Community Nodes** feature in n8n.
+
+1. Open your n8n instance
+2. Go to **Settings → Community Nodes → Install**
+3. Enter the following package names:
+
+```
+@rjsebening/n8n-nodes-evolution-api
+```
+
+Both packages contain the same code.
+The scoped version exists to avoid name collisions with potential future official integrations.
+
+4. Restart n8n → the node will be available
+
+---
+
+## 🔑 Set Up API Credentials
+
+1. In n8n, go to **Credentials → Create New**
+2. Search for **“Evolution API”**
+3. Enter your credentials:
+
+   * **Server URL**: Base URL of your Evolution API instance
+     *(e.g. `https://your-evolution-api.domain`)*
+   * **API Key**: Your Evolution API key
+
+---
+
+### Obtain Your API Key
+
+1. Open your Evolution API dashboard
+2. Navigate to **Settings / API**
+3. Generate or copy your API key
+4. Use it inside n8n credentials
+
+---
+
+## ⚙️ Available Actions
+
+### **Messaging**
+
+| Action             | Description                             |
+| ------------------ | --------------------------------------- |
+| Send Text Message  | Send plain WhatsApp messages            |
+| Send Media Message | Send images, documents, audio, or video |
+| Send Poll          | Send interactive poll messages          |
+| Send to Group      | Send messages to WhatsApp groups        |
+
+---
+
+### **Groups & Chats**
+
+| Action              | Description                   |
+| ------------------- | ----------------------------- |
+| Create Group        | Create a new WhatsApp group   |
+| Update Group        | Change group name or settings |
+| Add Participants    | Add users to a group          |
+| Remove Participants | Remove users from a group     |
+| Fetch Chats         | Load chats from an instance   |
+| Fetch Groups        | Retrieve group metadata       |
+
+---
+
+### **Instance Operations**
+
+| Action              | Description                         |
+| ------------------- | ----------------------------------- |
+| List Instances      | Retrieve all available instances    |
+| Get Instance Status | Check connection state              |
+| Restart Instance    | Restart a WhatsApp instance         |
+| Logout Instance     | Logout an instance                  |
+| Get QR Code         | Retrieve QR code for authentication |
+
+---
+
+### **Utility**
+
+| Action              | Description                   |
+| ------------------- | ----------------------------- |
+| Test Authentication | Verify API key and connection |
+| Health Check        | Validate server availability  |
+
+---
+
+## 📖 Example Use Cases
+
+* Send WhatsApp notifications when a deal is closed
+* Automatically inform teams via WhatsApp
+* Build WhatsApp-based onboarding flows
+* Control WhatsApp instances from backend automations
+* Integrate WhatsApp messaging into ERP, CRM, or internal tools
+
+---
+
+## 🌍 Why this matters
+
+WhatsApp is often mission-critical — but manual handling doesn’t scale.
+
+This node allows you to:
+
+* centralize control
+* automate communication
+* reduce human error
+* build reliable, backend-driven WhatsApp workflows
+
+All without custom code.
+
+---
+
+## 📬 About the Author
+
+I’m **Rezk Jörg Sebening** – Business Automation Expert (DACH).
+I build automation systems, scalable workflows, and n8n community nodes for agencies and growing companies.
+
+👉 Follow me on GitHub to stay updated with new integrations and automation tooling.
+
+---
+
+## 📋 Disclaimer
+
+This is an **unofficial community node** and is **not affiliated with the Evolution API project**.
+
+**Important Notes:**
+
+* This node is maintained by the community
+* API behavior depends on the Evolution API version
+* For Evolution API issues, consult the official documentation
+* All trademarks and logos belong to their respective owners

package/dist/credentials/EvolutionApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class EvolutionApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/EvolutionApi.credentials.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EvolutionApi = void 0;
+class EvolutionApi {
+    constructor() {
+        this.name = 'evolutionApi';
+        this.displayName = 'Evolution API';
+        this.documentationUrl = 'https://doc.evolution-api.com/';
+        this.properties = [
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: '',
+                placeholder: 'https://api.your-domain.com',
+                description: 'The URL where your Evolution API instance is hosted',
+            },
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'The Global API Key defined in your Evolution API env',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    apikey: '={{$credentials.apiKey}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl}}',
+                url: '/instance/fetchInstances',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.EvolutionApi = EvolutionApi;
+//# sourceMappingURL=EvolutionApi.credentials.js.map

package/dist/credentials/EvolutionApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvolutionApi.credentials.js","sourceRoot":"","sources":["../../credentials/EvolutionApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAY;IAAzB;QACC,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAG,eAAe,CAAC;QAC9B,qBAAgB,GAAG,gCAAgC,CAAC;QACpD,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,6BAA6B;gBAC1C,WAAW,EAAE,qDAAqD;aAClE;YACD;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,sDAAsD;aACnE;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,MAAM,EAAE,0BAA0B;iBAClC;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,0BAA0B;gBAC/B,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AAzCD,oCAyCC"}

package/dist/nodes/EvolutionApi/EvolutionApi.node.d.ts

@@ -0,0 +1,13 @@
+import { IExecuteFunctions, INodeType, INodeTypeDescription } from 'n8n-workflow';
+import * as instanceLoadOptions from './methods/loadOptions/instance.loadOptions';
+import * as groupLoadOptions from './methods/loadOptions/group.loadOptions';
+export declare class EvolutionApi implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getInstances: typeof instanceLoadOptions.getInstances;
+            getGroups: typeof groupLoadOptions.getGroups;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<import("n8n-workflow").INodeExecutionData[][]>;
+}