Evolution APIInstall

Overview

This node integrates with the Evolution API v2, enabling automation and management of various resources such as instances, messages, groups, chats, events, and integrations. Specifically, the "Criar Instância" (Create Instance) operation under the "Instância" (Instance) resource allows users to create a new instance by providing a name and additional JSON data.

Common scenarios for this node include:

• Automating the creation and management of communication instances.
• Integrating messaging workflows with external systems.
• Managing groups, sending messages, and handling chat interactions programmatically.

Practical example:

• Automatically create a new communication instance with specific configuration data when onboarding a new client or setting up a new environment.

Properties

Output

The output is a JSON object representing the response from the Evolution API after attempting to create an instance. It typically includes:

• The details of the created instance as returned by the API.
• A success boolean indicating if the operation was successful.
• A timestamp marking when the operation completed.

If the API returns no content, the node outputs a generic success message with a timestamp.

Example output structure:

{
  "instanceName": "example-instance",
  "id": "12345",
  "status": "created",
  "success": true,
  "timestamp": "2024-06-01T12:00:00.000Z"
}

No binary data output is produced by this operation.

Dependencies

• Requires an API key credential for authenticating requests to the Evolution API.
• The node uses HTTP methods (POST) to communicate with the Evolution API endpoints.
• Proper configuration of the API authentication within n8n is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Malformed JSON in the "Instance Data" property can cause parsing errors.
  • Providing an empty or duplicate instance name may result in API errors.

• Error messages:

  • Authentication errors: Ensure the API key credential is correctly set up and valid.
  • JSON parse errors: Verify that the "Instance Data" field contains valid JSON.
  • API response errors: Check the instance name uniqueness and required fields.

• Resolution tips:

  • Validate JSON input before running the node.
  • Confirm API credentials and permissions.
  • Review API documentation for required instance parameters.

Links and References

• Evolution API Documentation (hypothetical link, replace with actual if available)
• n8n HTTP Request Node documentation for understanding requestWithAuthentication usage: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/