Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource "Grupo" and operation "Entrar No Grupo" (Join Group), it enables an instance to join a specified group using an invite code. This is useful in scenarios where automated workflows need to programmatically add instances or users to groups within the Evolution platform, such as onboarding new members or integrating group-based communication features.

Practical example: Automatically joining a chat or collaboration group when a new user signs up, by providing the instance name and the group's invite code.

Properties

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

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.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint to be accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or expired invite code leading to failure in joining the group.
    • Incorrect instance name causing the API to reject the request.
    • Network connectivity problems preventing access to the Evolution API.
    • Missing or invalid API credentials resulting in authentication errors.
  • Error messages:

    • "Operação não suportada." indicates that the requested operation is not supported by the node; ensure the correct resource and operation names are used.
    • API errors returned from the Evolution service should be checked for details like invalid invite codes or permission issues.
  • Resolutions:

    • Verify the invite code is correct and active.
    • Confirm the instance name matches what is expected by the Evolution API.
    • Check API credentials and renew if necessary.
    • Ensure network connectivity and API endpoint availability.

Links and References

Discussion