WAHA API icon

WAHA API

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

Actions55

Overview

The node integrates with the WAHA API to manage WhatsApp groups and their participants. Specifically, the "Get Participants" operation retrieves the list of participants in a specified WhatsApp group chat. This is useful for scenarios where you need to monitor group membership, automate participant management, or synchronize group data with other systems.

Practical examples include:

  • Automatically fetching current group members to send targeted messages.
  • Auditing group participants for compliance or reporting.
  • Triggering workflows based on changes in group membership.

Properties

Name Meaning
Session Name The name of the WhatsApp session to use (defaults to a configured default session).
Chat ID The unique identifier of the WhatsApp group chat (e.g., groupid@g.us).
Additional Fields Optional extra parameters; not used specifically by this operation but available generally.

Output

The output JSON contains the response from the WAHA API endpoint that lists group participants. It typically includes an array of participant objects with details such as participant IDs, roles (e.g., admin or member), and possibly status information.

No binary data is returned by this operation.

Example output structure (simplified):

{
  "participants": [
    {
      "id": "1234567890@c.us",
      "isAdmin": true,
      "isSuperAdmin": false,
      "status": "active"
    },
    {
      "id": "0987654321@c.us",
      "isAdmin": false,
      "isSuperAdmin": false,
      "status": "active"
    }
  ]
}

Dependencies

  • Requires a valid WAHA API credential with an API key and base URL configured in n8n.
  • Optionally uses an additional API key credential for subscription validation via the "N8N Tools API".
  • The node sends HTTP requests to the WAHA API endpoints to perform operations.

Troubleshooting

  • Invalid Credentials: If the API key or session name is incorrect, the node will fail. Verify credentials and session configuration.
  • Unauthorized Errors: The node performs a subscription validation call; if it returns 401 or 403, check your subscription status and API keys.
  • Unknown Group or Chat ID: Providing an invalid or non-existent group chat ID will cause errors. Ensure the chat ID is correct and corresponds to a WhatsApp group.
  • Network Issues: Connectivity problems to the WAHA API endpoint can cause timeouts or failures. Check network access and API availability.

Links and References

Discussion