Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" provides an interface to interact with the Evolution API, specifically supporting operations on various resources. For the resource Grupo and operation Encontrar Participantes, it allows users to find participants of a specified group by providing the group ID and instance name. This is useful in scenarios where you need to retrieve member information from a group within the Evolution platform, such as for auditing, reporting, or managing group memberships.

Practical example: You want to get a list of all participants in a particular chat group identified by its unique group ID to display or process their details further in your workflow.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group exists. It identifies the specific environment or deployment of the Evolution API to query.
ID Do Grupo The unique identifier (ID) of the group whose participants you want to find.

Output

The output of the node is a JSON array containing the data returned by the Evolution API for the participants of the specified group. Each item in the array represents a participant with their associated details as provided by the API.

If the API returns binary data related to participants (e.g., profile pictures), it would be included in the binary output field, but based on the code and properties, the primary output is JSON data describing participants.

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • The node expects the Evolution API endpoint to be accessible and properly configured.
  • No additional external dependencies are indicated beyond the API access.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource combination, the node throws an error indicating the operation is not supported. Ensure that the resource is set to "groups-api" and operation to "find-participants".
  • Missing required parameters: Both "Nome Da Instância" and "ID Do Grupo" are required. Omitting these will cause the node to fail.
  • API authentication errors: If the API key or credentials are invalid or missing, the node will fail to authenticate. Verify the API key configuration.
  • Network or API errors: Connectivity issues or API downtime can cause failures. Check network connectivity and API status.

Links and References

  • Evolution API official documentation (not provided in source; consult your API provider)
  • n8n documentation on creating custom nodes and using API credentials: https://docs.n8n.io/
  • General REST API usage best practices

Discussion