Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node "Evolution API" allows interaction with the Evolution API service, specifically supporting operations on various resources. For the resource Grupo and operation Buscar Grupos, it enables fetching group information from the Evolution API based on different search methods: by invite code, by group ID, or fetching all groups. It can optionally retrieve the list of participants for all groups when fetching all.

This node is useful in scenarios where you need to integrate group data from the Evolution platform into your workflows, such as syncing group details, managing memberships, or automating notifications based on group membership.

Practical examples:

  • Fetching a specific group’s details using its invite code to display or process group info.
  • Retrieving all groups in an instance to generate reports or perform bulk updates.
  • Getting participant lists for all groups to analyze membership or send targeted messages.

Properties

Name Meaning
Nome Da Instância The name of the Evolution API instance to connect to.
Método De Busca The method used to search for groups. Options: "Por Código De Convite", "Por ID Do Grupo", "Buscar Todos Os Grupos".
Código Do Convite The invite code of the group to fetch (required if searching by invite code).
ID Do Grupo The unique identifier of the group to fetch (required if searching by group ID).
Obter Participantes Boolean flag indicating whether to retrieve the list of participants for all groups (only applicable when fetching all groups).

Output

The node outputs a JSON array containing the fetched group data. Each item in the array represents a group object with its details as returned by the Evolution API. If the option to obtain participants is enabled when fetching all groups, each group object will also include a list of its participants.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The node expects the Evolution API endpoint to be accessible and properly configured for the given instance name.
  • No additional external dependencies beyond the Evolution API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Incorrect or missing instance name may cause connection failures.
    • Providing an invalid invite code or group ID will result in no data found or error responses.
    • Enabling participant retrieval without proper permissions might lead to incomplete data or errors.

  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not implemented for the chosen resource; verify the resource and operation names.
    • API authentication errors suggest checking the configured API key credential.
    • Network or timeout errors imply connectivity issues with the Evolution API endpoint.

Links and References

Discussion