WAHA API icon

WAHA API

Complete WhatsApp automation with WAHA API - Multi-engine support

Overview

This node integrates with the WAHA API to send WhatsApp messages and perform various message-related operations. Specifically, the "Send Text" operation under the "Message" resource allows users to send plain text messages to individual chats or groups on WhatsApp.

Common scenarios where this node is beneficial include:

  • Automating customer support by sending notifications or replies via WhatsApp.
  • Broadcasting updates or alerts to WhatsApp groups or contacts.
  • Integrating WhatsApp messaging into workflows for marketing, reminders, or transactional messages.

For example, a business could use this node to automatically send order confirmations or appointment reminders as WhatsApp text messages to customers.

Properties

Name Meaning
Session Name The name of the WhatsApp session to use for sending the message. Defaults to a configured default session.
Chat ID The WhatsApp chat identifier to send the message to. This can be a phone number with @c.us suffix or a group ID with @g.us.
Text The content of the text message to send.
Additional Fields Optional extra parameters that can customize the message or related operations. For "Send Text", these fields are generally unused but available for other operations.

The Additional Fields collection includes options like Filename, Mimetype, Link Description, Contact Name, Reaction emoji, Limit for results, and Download Media flag, but these are not applicable for the "Send Text" operation itself.

Output

The node outputs a JSON object representing the response from the WAHA API after attempting to send the text message. This typically includes details about the sent message such as message ID, status, timestamps, or error information if the request failed.

If an error occurs and the node is set to continue on failure, the output JSON will contain an error field with the error message.

No binary data output is produced by the "Send Text" operation.

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 and access via the n8n Tools API.
  • The node expects a configured WhatsApp session identified by the "Session Name" property.
  • Network connectivity to the WAHA API endpoint is necessary.

Troubleshooting

  • Invalid Credentials: If the API key or subscription is invalid, the node throws an error indicating invalid subscription or API key. Verify credentials in n8n settings.
  • Unknown Operation or Resource: Errors occur if unsupported operations or resources are specified. Ensure "Message" resource and "Send Text" operation are selected.
  • Invalid Chat ID: Sending to an incorrectly formatted chat ID (not ending with @c.us or @g.us) may cause failures. Confirm the chat ID format.
  • Session Issues: If the specified WhatsApp session is not active or misconfigured, message sending will fail. Check session status and configuration.
  • Network or API Errors: General HTTP errors or timeouts may happen; check network connectivity and WAHA API service status.

Links and References

Discussion