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 "Buscar Grupos," it enables searching for groups using different methods such as by invite code, by group ID, or fetching all groups. It can optionally retrieve the list of participants in the groups when fetching all groups.

Common scenarios where this node is beneficial include:

  • Automating group management tasks by programmatically retrieving group details.
  • Integrating group data into workflows for notifications, analytics, or synchronization.
  • Fetching participant lists to manage or audit group membership.

Practical example:

  • A user wants to fetch information about a specific group by its invite code to display group details in a dashboard.
  • Another use case is to fetch all groups and their participants to generate reports on group activity.

Properties

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

Output

The node outputs a JSON array containing the group data retrieved based on the selected search method. The structure of each JSON object depends on the search method but generally includes group details such as group identifiers, names, and optionally participant lists if requested.

If participant retrieval is enabled, the output will include an array of participants associated with each group.

No binary data output is indicated.

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 credential within n8n is necessary.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing an incorrect invite code or group ID may result in no data found or errors.
    • Not setting required properties depending on the chosen search method (e.g., not providing invite code when searching by invite code) will cause validation errors.
  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not supported for the resource.
    • Errors related to missing parameters should be resolved by ensuring all required fields are filled according to the selected search method.

Links and References

Discussion