Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to perform various operations related to WhatsApp messaging and instance management. Specifically, for the Chat resource with the Ler Mensagem (markMessageAsRead) operation, it marks a message as read in a specified WhatsApp instance.

Common scenarios where this node is beneficial include automating message status updates in WhatsApp workflows, such as marking incoming messages as read after processing them or integrating with customer support systems to update message states automatically.

Practical example: After receiving a new message via WhatsApp, you can use this node to mark that message as read, signaling to the sender that their message has been seen.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance where the message will be marked as read. This identifies which connected WhatsApp session to operate on.

Output

The node outputs a JSON object containing the result of the operation. The output includes:

  • success: A boolean indicating if the operation was successful.
  • message: A confirmation message (e.g., "Operation completed successfully").
  • timestamp: The ISO timestamp when the operation was performed.

If the API returns additional data, it will be included in the output JSON. In case of errors, an error message will be provided instead.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Evolution API v2.
  • Requires an API authentication token configured in n8n credentials to authorize requests.
  • The WhatsApp instance must be created and connected beforehand within the Evolution API environment.

Troubleshooting

  • Common issues:

    • Invalid or disconnected instance name: Ensure the instance name provided matches an active and connected WhatsApp instance.
    • Authentication failures: Verify that the API key credential is correctly set up and has necessary permissions.
    • Network or API downtime: Check connectivity to the Evolution API service.
  • Error messages:

    • "Instance not found": The specified instance name does not exist or is not connected.
    • "Unauthorized": API key is missing or invalid.
    • "Operation failed": General failure; check API response details for more information.

To resolve these, confirm instance status in the Evolution API dashboard, validate credentials, and ensure network access.

Links and References

Discussion