Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. Specifically, for the Message resource and the Send PIX operation, it enables sending PIX payments—a popular instant payment method in Brazil—via the Evolution API.

Typical use cases include automating PIX payment requests or transfers by specifying beneficiary details and payment keys programmatically within an n8n workflow. For example, a business could automatically send PIX payment instructions to customers or partners after an order is confirmed.

Properties

Name Meaning
Name Da Instância The name of the instance that will send the PIX payment.
Número Do Destinatário The recipient's number (likely a chat or contact identifier) where the PIX message is sent.
Name Do Beneficiário The name of the PIX payment beneficiary (recipient).
Tipo Da Chave The type of PIX key used for the transaction. Options: Telefone, E-Mail, CPF, CNPJ, Aleatória (Random).
Chave PIX The actual PIX key value of the beneficiary.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the PIX payment. The exact structure depends on the API response but typically includes confirmation details or error information related to the PIX transaction.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for API requests is https://doc.evolution-api.com/api-reference.
  • Proper configuration of the Evolution API credentials in n8n is necessary.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the Resource is set to "messages-api" and the Operation to "send-pix".
  • Missing Required Parameters: Ensure all required properties (instance name, recipient number, beneficiary name, key type, and PIX key) are provided; missing any will cause errors.
  • API Authentication Errors: Confirm that the API key credential is correctly configured and valid.
  • Invalid PIX Key or Type: Providing an incorrect PIX key or mismatched key type may result in API errors; double-check these values.
  • Network Issues: Connectivity problems to the Evolution API endpoint can cause failures; ensure network access is available.

Links and References

Discussion