Evolution APIInstall

Overview

The node integrates with the Evolution API to manage WhatsApp instances and perform various WhatsApp-related operations. Specifically, for the Instance resource and Connect Instance operation, it connects a configured WhatsApp instance to the WhatsApp service, enabling message sending and receiving through that instance.

This node is useful in automation workflows where you want to programmatically control WhatsApp instances, such as connecting an instance after creation or reconnecting it if disconnected. For example, after creating a new WhatsApp instance, you can use this node to establish the connection automatically without manual intervention.

Properties

Note: For the Connect Instance operation, the main required input is the instance name (configured in credentials), so no additional direct inputs are needed beyond optional additional fields.

Output

The node outputs JSON data representing the response from the Evolution API when connecting the instance. This typically includes status information about the connection attempt, such as success confirmation or error details.

The output structure is:

{
  "json": {
    // Response object from the Evolution API connect instance endpoint
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

• Requires an API key credential for the Evolution API, including base URL, API key, and instance name.
• Optionally uses another API key credential for a validation service ("N8N Tools API") to verify subscription and API key validity before making requests.
• The node makes HTTP POST or GET requests to the Evolution API endpoints.
• Proper configuration of these credentials and network access to the API endpoints is necessary.

Troubleshooting

• Invalid Subscription or API Key: If the validation request to the secondary API fails with 401 or 403, the node throws an error indicating invalid subscription or API key. Verify that your API keys and subscription status are correct.
• Unknown Operation or Resource: If an unsupported operation or resource is selected, the node throws an error specifying the unknown operation/resource. Ensure you select valid options.
• Connection Failures: Network issues or incorrect instance names may cause connection failures. Check network connectivity and that the instance name matches the one registered in the Evolution API.
• API Errors: Any errors returned by the Evolution API will be included in the node output. Review the error messages for troubleshooting.

Links and References

• Evolution API Documentation (Replace with actual URL)
• WhatsApp Business API general info: https://developers.facebook.com/docs/whatsapp
• n8n HTTP Request Node documentation: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/

This summary focuses on the Instance resource and Connect Instance operation as requested.