WAHA API icon

WAHA API

Complete WhatsApp automation with WAHA API - Multi-engine support
Join our community

Actions55

Overview

This node integrates with the WAHA API to manage WhatsApp groups and perform various group-related operations. Specifically, the "Add Participants" operation allows users to add one or more participants to an existing WhatsApp group by specifying the group chat ID and a list of participant IDs.

Common scenarios where this node is beneficial include:

  • Automating group management tasks such as adding new members to a team or community group.
  • Integrating WhatsApp group updates into broader workflows, e.g., onboarding new users by automatically adding them to relevant groups.
  • Managing large groups programmatically without manual intervention.

Practical example:

  • A company uses this node in an n8n workflow to add newly registered customers to a WhatsApp support group by providing the group's chat ID and the customers' WhatsApp IDs.

Properties

Name Meaning
Session Name The name of the WhatsApp session to use for the operation (defaults to a configured session).
Chat ID The WhatsApp group chat ID where participants will be added (e.g., groupid@g.us).
Participants Comma-separated list of WhatsApp IDs of participants to add to the group.
Additional Fields Optional extra parameters; not used directly in this operation but available for other ops.

Output

The node outputs a JSON object representing the response from the WAHA API after attempting to add participants to the specified group. This typically includes confirmation details about the operation's success or failure and any relevant metadata returned by the API.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "success": true,
  "addedParticipants": [
    "5511999999999@c.us",
    "5511888888888@c.us"
  ],
  "groupId": "groupid@g.us",
  "message": "Participants added successfully"
}

Dependencies

  • Requires an active WAHA API credential with a valid base URL and API key.
  • Optionally uses an additional API key credential for validating subscription via the n8n Tools API.
  • The node expects the WhatsApp session to be active and accessible.
  • Proper configuration of the WhatsApp session name is necessary if multiple sessions exist.

Troubleshooting

  • Invalid Credentials: If the WAHA API key or session name is incorrect or expired, the node will fail. Verify credentials and session status.
  • Unauthorized Access: Errors related to the n8n Tools API validation indicate invalid subscription or API key. Check that the API key is correct and has the required permissions.
  • Invalid Chat ID or Participants: Ensure the group chat ID and participant IDs are correctly formatted (e.g., phone numbers with @c.us or group IDs with @g.us) and that the participants are valid WhatsApp users.
  • Unknown Operation or Resource: If the operation or resource is mistyped or unsupported, the node throws an error indicating the unknown operation/resource.
  • Network Issues: Connectivity problems with the WAHA API endpoint can cause request failures. Confirm network access and API availability.

Links and References

Discussion