Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" provides integration with the Evolution API, allowing users to perform various operations on different resources. Specifically, for the Group resource and the Join Group operation, this node enables an instance to join a group by providing the instance name and the group's invite code. This is useful in scenarios where automated workflows need to manage group memberships dynamically, such as adding new instances or users to collaboration groups based on external triggers.

Practical examples include:

  • Automatically joining a newly created instance to a predefined group using an invite code.
  • Managing group memberships in bulk by iterating over multiple instances and joining them to groups programmatically.

Properties

Name Meaning
Name Da Instância The name of the instance that will join the group.
Código Do Convite The invite code of the group (e.g., JZNHJLvnNd04UvGefiEZAA) used to authorize joining.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to join the group. The exact structure depends on the API's response but typically includes confirmation details about the joined group or error information if the join failed.

If the API supports binary data output, it would be summarized here; however, based on the provided code and properties, the output is purely JSON.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or expired invite codes will prevent joining the group.
    • Incorrect instance names may cause the API to reject the request.
    • Missing or misconfigured API credentials will result in authentication errors.
  • Error messages:

    • "Operação não suportada." indicates that the requested operation is not supported for the selected resource. Ensure the resource and operation names are correct.
    • API errors returned from the Evolution API will be passed through; check the API documentation for specific error codes and messages.
  • Resolutions:

    • Verify the invite code and instance name inputs.
    • Confirm API credentials are correctly set up and valid.
    • Check network connectivity to the Evolution API endpoint.

Links and References

Discussion