Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node allows you to interact with the Evolution API, specifically to fetch a group invite link ("Buscar Link De Convite") for a WhatsApp group. It is useful in scenarios where you need to programmatically retrieve the invitation code for a group managed by your WhatsApp instance, such as automating onboarding processes or sharing group access.

Practical Example:
You can use this node to automatically obtain and distribute a WhatsApp group invite link after creating a new group or when managing group memberships in automated workflows.

Properties

Display Name Type Description
Nome Da Instância String Digite o nome da instância que vai buscar o código.
Enter the name of the instance that will fetch the code. (Required)
ID Do Grupo String ID do grupo para obter o código de convite.
The group ID for which to obtain the invite code. (Required)

Output

The output is a JSON object (or array of objects) containing the result from the Evolution API for fetching the group invite code. The exact structure depends on the API response, but typically includes fields such as:

{
  "inviteCode": "xxxxxxxx",
  "groupJid": "123456789@g.us",
  // ...other possible metadata
}
  • inviteCode: The actual invite code or link for the specified group.
  • groupJid: The unique identifier of the group.

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid Evolution API credentials in n8n under the credential type evolutionApi.
  • n8n Configuration: No additional configuration required beyond setting up the credentials.

Troubleshooting

  • Common Issues:

    • Invalid Instance Name or Group ID: Ensure both fields are filled correctly; otherwise, the API may return an error or no data.
    • Missing Credentials: If credentials are not set up, the node will fail to authenticate with the Evolution API.
    • Unsupported Operation Error: If the operation or resource is not supported, you may see an error message like:
      Operação não suportada.
      A função "fetch-invite-code" para o recurso "groups-api" não é suportada!
      
      Resolution: Double-check that you have selected the correct resource and operation.
  • API Errors: Any errors returned by the Evolution API (such as invalid group ID, permission issues, etc.) will be passed through as node errors.

Links and References

Discussion