Skip to content

green-api/n8n-nodes-whatsapp-green-api

Repository files navigation

n8n-nodes-whatsapp-green-api

Integration node for Green API in n8n.
This community node allows automation of WhatsApp interactions using Green API β€” including messaging, file transfer, contacts, groups, statuses, and instance management.


πŸ“– Overview

The GreenAPI Node provides full access to Green API endpoints, enabling you to send messages, manage chats, groups, and retrieve account information.


Installation

Install community node

Go to Settings β†’ Community Nodes β†’ Install, then enter n8n-nodes-whatsapp-green-api

Install via npm

npm install n8n-nodes-whatsapp-green-api

Restart n8n after installation.

Manual installation

  1. Copy repository into ~/.n8n/custom/
  2. Run:
    npm install
    npm run build
  3. Restart n8n

You can also check out the installation guide in the n8n community nodes documentation.


Authentication

To use this node, you need to have an instance and token from Green-API platform and WhatsApp account:

  • Sign up at Green-API
  • Create an instance
  • Get idInstance and apiTokenInstance
  • Authorize the instance in the Console

🧩 Features

Category Methods
πŸ‘€ Account getSettings, setSettings, getStateInstance, reboot, logout, getWaSettings
βœ‰οΈ Sending sendMessage, sendPoll, sendFileByUrl, sendLocation, sendContact, forwardMessages, sendInteractiveButtons, sendInteractiveButtonsReply
πŸ“₯ Receiving webhookTrigger, downloadFile
πŸ“œ Journals getChatHistory, getMessage, lastIncomingMessages, lastOutgoingMessages
🧾 Queues showMessagesQueue, clearMessagesQueue
πŸ‘₯ Groups createGroup, updateGroupName, getGroupData, addGroupParticipant, deleteGroupParticipant, setGroupAdmin, removeGroupAdmin, leaveGroup
πŸ“£ Statuses sendTextStatus, sendVoiceStatus, sendMediaStatus, deleteStatus, getStatusStatistic, getIncomingStatuses, getOutgoingStatuses
βœ… Readmark readChat
🧩 Service getContacts, getContactInfo, editMessage, deleteMessage, archiveChat, unarchiveChat, setDisappearingChat

βš™οΈ Usage Examples

πŸ’¬ Send Message

{
  "operation": "sendMessage",
  "chatId": "[email protected]",
  "message": "Hello from n8n and Green API!"
}

πŸ“Ž Send File by URL

{
  "operation": "sendFileByUrl",
  "chatId": "[email protected]",
  "urlFile": "https://example.com/image.jpg",
  "fileName": "photo.jpg"
}

πŸ“£ Send Text Status

{
  "operation": "sendTextStatus",
  "message": "Working with Green-API and n8n!",
  "backgroundColor": "#228B22",
  "font": "SERIF",
  "participants": []
}

πŸ“€ Send Interactive Buttons Reply

{
  "operation": "sendInteractiveButtonsReply",
  "chatId": "[email protected]",
  "header": "",
  "body": "Do you confirm the appointment for tomorrow?",
  "footer": "",
  "buttons": [
        {
            "buttonId": "1",
            "buttonText": "Yes"
        },
        {
            "buttonId": "2",
            "buttonText": "No"
        }
    ]
}

πŸ‘₯ Create Group

{
  "operation": "createGroup",
  "groupName": "My Team",
  "participants": ["[email protected]", "[email protected]"]
}

🧭 Send Location

{
  "operation": "sendLocation",
  "chatId": "[email protected]",
  "latitude": 40.7128,
  "longitude": -74.0060,
  "name": "New York",
  "address": "NY, USA"
}

πŸ”„ Check Whatsapp

{
  "operation": "checkWhatsapp",
  "phoneNumber": 79000000000
}

πŸ”— Resources


πŸ‘€ Author

Developed by Green API
πŸ“§ [email protected]
🌍 https://green-api.com/en/


πŸͺͺ License

MIT License

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •