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, specifically allowing users to set or update the description of a WhatsApp group. It is useful in scenarios where group administrators want to programmatically update the group's description to provide current information, rules, or announcements without manually editing it in the WhatsApp app.

For example, an organization managing multiple WhatsApp groups for different projects can automate updating group descriptions to reflect project status or meeting schedules dynamically.

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).
Description The new description text to set for the WhatsApp group.
Additional Fields A collection of optional fields (not used directly in this operation but available generally).

Output

The node outputs a JSON object representing the response from the WAHA API after attempting to set the group description. This typically includes confirmation of success or details about the updated group. The output is structured as:

{
  "json": {
    // API response data confirming the update or error details
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data output is involved in this operation.

Dependencies

  • Requires an active WAHA API credential with a valid base URL and API key.
  • Optionally uses an additional API key credential for subscription validation via the n8n Tools API.
  • The node requires proper configuration of these credentials within n8n to authenticate requests successfully.

Troubleshooting

  • Invalid Credentials: If the WAHA API key or session name is incorrect, the node will fail. Ensure that the API key and session name are correctly set and active.
  • Unauthorized Errors: The node performs a validation call to the n8n Tools API; if this fails with 401 or 403 errors, verify that the subscription and API keys for the n8n Tools API are valid.
  • Unknown Group or Chat ID: Providing an invalid or non-existent group chat ID will cause the API request to fail. Confirm the group ID format and existence.
  • API Endpoint Errors: Network issues or incorrect base URLs can cause request failures. Check connectivity and the correctness of the WAHA API base URL.
  • Handling Failures: The node supports continuing on failure; enabling this option allows workflows to proceed even if setting the description fails, returning error details in the output JSON.

Links and References

Discussion