Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to automate WhatsApp group management tasks. Specifically, the "Add Participant" operation allows users to add one or more participants to an existing WhatsApp group by specifying the group ID and the phone numbers of the participants.

Common scenarios where this node is beneficial include:

  • Automatically adding new members to a WhatsApp group as part of onboarding workflows.
  • Managing group membership dynamically based on external triggers or events.
  • Integrating WhatsApp group updates into broader automation pipelines.

For example, a business could use this node to add customers to a support group after they register on a website, ensuring timely communication within WhatsApp groups.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to which participants will be added.
Participants Comma-separated list of phone numbers (including country code) representing the new members.
Additional Fields Optional settings including:
• Delay (ms before sending)
• Link Preview (enable/disable)
• Quoted Message ID (to reply to a specific message)
• Mentions (comma-separated numbers to mention in messages)

Output

The node outputs a JSON object containing the response from the Evolution API after attempting to add participants. This typically includes confirmation details about the updated group or error information if the operation failed.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "json": {
    "status": "success",
    "groupJid": "12345-67890@g.us",
    "addedParticipants": [
      "5511999999999@s.whatsapp.net",
      "5511988888888@s.whatsapp.net"
    ]
  }
}

Dependencies

  • Requires an active subscription and valid API key credentials for the Evolution API service.
  • Optionally uses an additional API validation service requiring its own API URL and key.
  • The node expects configuration of these credentials within n8n's credential manager.
  • Network access to the Evolution API endpoints is necessary.

Troubleshooting

  • Invalid API Key or Subscription: If the node throws errors related to invalid subscription or API key, verify that the provided API keys are correct and have the necessary permissions.
  • Group Not Found: Errors may occur if the specified Group ID does not exist or is incorrect. Double-check the group identifier.
  • Malformed Phone Numbers: Ensure participant phone numbers are correctly formatted with country codes and no extra characters.
  • API Rate Limits: Frequent calls might hit rate limits imposed by the Evolution API; consider adding delays or batching requests.
  • Permission Issues: The authenticated instance must have admin rights in the WhatsApp group to add participants.

Links and References

Discussion