Actions64
- Instance Actions
- Message Actions
- Group Actions
- Integration Actions
- Chat Actions
- Profile Actions
- Event Actions
Overview
The node "Evolution API" provides an interface to interact with the Evolution API, specifically supporting various resources and operations. For the Message resource with the Send PIX operation, it enables sending a PIX payment message to a specified recipient. This is useful in scenarios where automated financial transactions or payment notifications need to be sent programmatically via the Evolution API.
Practical examples include:
- Sending a PIX payment request to a customer after an order is placed.
- Automating payment reminders or confirmations using PIX keys.
- Integrating PIX payments into chatbots or messaging platforms that support the Evolution API.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the instance that will send the PIX payment message. |
| Recipient Number | The phone number or identifier of the recipient who will receive the PIX message. |
| Beneficiary Name | The full name of the PIX beneficiary (the person receiving the payment). |
| Key Type | The type of PIX key used for the transaction. Options: Phone, Email, CPF, CNPJ, Random. |
| PIX Key | The actual PIX key value of the beneficiary to which the payment will be sent. |
Output
The node outputs a JSON array containing the response from the Evolution API after attempting to send the PIX message. The structure typically includes details about the success or failure of the operation, such as confirmation IDs, status messages, or error information.
If the node supports binary data output (not evident from the provided code), it would represent any associated files or media related to the PIX message, but this is not indicated here.
Dependencies
- Requires an active connection to the Evolution API service.
- Needs an API authentication token or API key credential configured in n8n under the Evolution API credentials.
- The base URL for requests is set to
https://doc.evolution-api.com/api-reference. - The node depends on internal helper functions mapped in
resourceOperationsFunctionsto handle specific resource-operation logic.
Troubleshooting
- Operation Not Supported Error: If you select an unsupported operation for a resource, the node throws an error stating the function is not supported. Ensure the operation and resource names are correct and supported by the node.
- Missing Required Parameters: The node requires all properties marked as required (e.g., Instance Name, Recipient Number, Beneficiary Name, Key Type, PIX Key). Omitting these will cause errors.
- API Authentication Issues: Failure to provide valid API credentials or expired tokens will result in authentication errors. Verify your API key or token configuration.
- Network or API Errors: Connectivity issues or incorrect API endpoint configurations can cause failures. Check network access and base URL correctness.
Links and References
- Evolution API Documentation - Official API reference for detailed endpoint and parameter descriptions.
- PIX Payment System - Information about the Brazilian instant payment system PIX.
Note: The summary is based solely on static analysis of the provided source code and property definitions without runtime execution or dynamic import resolution.