Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node implements an integration with the Evolution API, specifically providing functionality to send documents as messages. The "Send Document" operation under the "Message" resource allows users to send a document file (via URL or base64) to a specified recipient number through a configured instance.

This node is useful in scenarios where automated workflows need to distribute files such as PDFs, reports, invoices, or any document format directly to users or groups via messaging platforms supported by the Evolution API. For example, a business could automatically send monthly statements to customers or share contracts with clients.

Properties

Name Meaning
Instance Name The name of the instance that will send the document.
Recipient Number The phone number or identifier of the message recipient.
Document The document to send, provided as a URL or base64 encoded string.
Message Optional text caption to accompany the document.
File Name The filename to assign to the sent document (default: "document.pdf").
Options Additional optional settings for sending the message:
- Delay Time delay in milliseconds before sending the message (default 1200 ms).
- Reply to Message Optionally specify a message ID to which this document message should reply.
- Mentions Settings to mention participants in group chats: either mention everyone or specific numbers (comma-separated).

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the document message. This typically includes metadata about the sent message such as message ID, status, timestamps, and any error information if applicable.

No binary data output is indicated; the document itself is sent via the API but not returned as binary data in the node output.

Dependencies

  • Requires an active Evolution API credential configured in n8n to authenticate requests.
  • Depends on the Evolution API service being accessible at https://doc.evolution-api.com/api-reference.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is unsupported, verify that the "Send Document" operation is correctly selected under the "Message" resource.
  • Missing Required Fields: Ensure all required properties like Instance Name, Recipient Number, and Document are provided; missing these will cause errors.
  • Invalid Document Format: The document must be a valid URL or base64 string; invalid formats may cause the API to reject the request.
  • API Authentication Failures: Check that the API key or authentication token is correctly set up in n8n credentials.
  • Delay Misconfiguration: Setting an excessively long or negative delay might cause unexpected behavior; use reasonable values.
  • Mention Settings: When mentioning specific numbers, ensure the list is comma-separated without extra spaces or invalid characters.

Links and References

Discussion