Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service, specifically supporting operations on various resources. For the resource Grupo and operation Criar Grupo, this node creates a new group instance within the specified Evolution API environment. This is useful for automating group management tasks such as setting up communication groups or collaborative teams programmatically.

Practical examples include:

  • Automatically creating project groups when new projects are initiated.
  • Setting up user groups for notifications or messaging platforms integrated with Evolution API.
  • Managing participant lists dynamically by adding multiple phone numbers to a newly created group.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group will be created.
Nome Do Grupo The name of the group to be created.
Descrição Optional description text for the group.
Participantes Comma-separated list of participant phone numbers (e.g., 5511999999999,5511888888888) to add.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to create the group. This typically includes details about the newly created group such as its ID, name, description, participants, and any status or metadata returned by the API.

If the API supports binary data in responses, it would be summarized here, but based on the provided code and properties, the output is purely JSON structured data representing the created group.

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 external dependencies beyond the Evolution API and n8n's standard HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Missing required fields like instance name, group name, or participants will cause errors.
    • Incorrectly formatted participant phone numbers (not comma-separated or invalid format) may lead to API rejection.
    • Network or authentication failures if the API key is invalid or the Evolution API service is unreachable.
  • Error messages:

    • "Operação não suportada." indicates that the requested operation is not implemented for the selected resource.
    • API errors returned from the Evolution API will be passed through; check the message for details such as invalid parameters or permission issues.
  • Resolutions:

    • Ensure all required input properties are correctly filled.
    • Validate participant phone numbers format before execution.
    • Verify API credentials and network connectivity.

Links and References

  • Evolution API official documentation (link not provided in source)
  • n8n documentation on creating custom nodes and using API credentials
  • General best practices for phone number formatting in APIs

Discussion