Evolution API

Complete WhatsApp automation with Evolution API

Actions48

Overview

This node integrates with the Evolution API to automate WhatsApp messaging and management tasks. Specifically, the "Message" resource with the "Mark as Read" operation allows users to mark one or more WhatsApp messages as read programmatically. This is useful in scenarios where you want to update message status automatically after processing them, such as in customer support workflows or chatbots, ensuring that messages are acknowledged without manual intervention.

For example, after a chatbot processes incoming messages, this node can mark those messages as read to keep the conversation state synchronized.

Properties

Name	Meaning
Phone Number	The recipient's phone number including country code (without the "+" sign).
Additional Fields	Optional extra parameters: - Delay: Delay in milliseconds before sending the request. - Link Preview: Enable or disable link preview in messages. - Quoted Message ID: ID of the message to quote or reply to. - Mentions: Comma-separated list of phone numbers to mention in the message.

Note: For the "Mark as Read" operation, the key additional field used is messageId (not listed explicitly in your provided properties but referenced in the code), which specifies the ID of the message to mark as read.

Output

The node outputs a JSON object representing the response from the Evolution API after marking the message(s) as read. The structure typically includes confirmation of the action or details about the updated message status.

Example output JSON structure:

{
  "success": true,
  "updatedMessages": [
    {
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": false,
      "id": "message-id"
    }
  ]
}

No binary data is output by this operation.

Dependencies

Requires an active Evolution API credential with valid base URL, API key, and instance name configured in n8n.
Optionally uses an additional API key credential for validation via the N8N Tools API.
The node makes HTTP POST requests to the Evolution API endpoints.
Proper network access to the Evolution API service is required.

Troubleshooting

Invalid subscription or API key error: If the node throws errors related to invalid subscription or API key, verify that the API credentials are correct and have the necessary permissions.
Missing or incorrect message ID: The "Mark as Read" operation requires a valid message ID in the additional fields (messageId). Omitting this or providing an incorrect ID will cause the operation to fail.
Network or connectivity issues: Ensure that the server running n8n can reach the Evolution API endpoint.
Unknown operation or resource errors: These indicate misconfiguration of the node parameters; ensure the Resource is set to "Message" and Operation to "Mark as Read".

Links and References

Evolution API Documentation (hypothetical link)
WhatsApp Business API concepts on message status: https://developers.facebook.com/docs/whatsapp/api/messages/message-status/
n8n HTTP Request Node documentation: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/

If you need further details on other operations or resources, feel free to ask!

Evolution APIInstall