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 sessions and perform various WhatsApp-related operations. Specifically, the "Get QR Code" operation under the "Session" resource retrieves the QR code for a specified WhatsApp session. This QR code is typically used to authenticate and link a WhatsApp client session by scanning it with the WhatsApp mobile app.

Common scenarios where this node is beneficial include:

  • Automating WhatsApp session management in workflows.
  • Retrieving the QR code to enable users to scan and authenticate their WhatsApp session programmatically.
  • Integrating WhatsApp messaging capabilities into business automation without manual intervention.

Practical example:

  • A workflow that starts a new WhatsApp session and then fetches the QR code image so it can be displayed or sent to an operator for scanning.

Properties

Name Meaning
Session Name The name of the WhatsApp session to operate on. Defaults to the configured default session.
Additional Fields A collection of optional fields (not used specifically in "Get QR Code" but available): Filename, Mimetype, Link Description, Link Title, Contact Name, Contact Number, Reaction, Limit, Download Media.

Note: For the "Get QR Code" operation, only the "Session Name" property is relevant.

Output

The output JSON contains the response from the WAHA API endpoint that provides the QR code for the specified session. This typically includes data representing the QR code image or its URL.

The structure is:

{
  "json": {
    // QR code data returned by the WAHA API, e.g. base64 image string or URL
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data output is explicitly handled by this operation.

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 validating subscription via the "N8N Tools API".
  • The node makes HTTP requests to the WAHA API endpoints.
  • Requires proper configuration of the WhatsApp session name to target the correct session.

Troubleshooting

  • Invalid API Key or Subscription: If the N8N Tools API validation fails with 401 or 403 errors, check that the API keys are correctly set and the subscription is active.
  • Unknown Session Name: If the session name does not exist or is incorrect, the WAHA API may return an error. Verify the session name matches an active WhatsApp session.
  • Network Issues: Ensure the WAHA API base URL is reachable from the n8n instance.
  • Operation Not Supported: Using an unsupported operation or resource combination will throw an error indicating unknown operation or resource.

Links and References

Discussion