WAHA API icon

WAHA API

Complete WhatsApp automation with WAHA API - Multi-engine support

Overview

This node integrates with the WAHA API to automate WhatsApp messaging and session management. Specifically, the "Message" resource with the "Stop Typing" operation allows you to send a command to stop the typing indicator in a specified WhatsApp chat. This is useful in scenarios where your automation or bot has started a typing indicator (to simulate human-like behavior) and needs to stop it once the message is ready or sent.

Practical examples:

  • A chatbot that shows typing status while processing user input can use this operation to stop the typing indicator once the response is ready.
  • Automated workflows that send multiple messages can start and stop typing indicators to improve user experience on WhatsApp.

Properties

Name Meaning
Session Name The name of the WhatsApp session to use. Defaults to the credential's default session name.
Chat ID The WhatsApp chat identifier where the typing indicator should be stopped. Format: phone number with @c.us or group ID with @g.us. Required.
Additional Fields Optional extra parameters (not used specifically for Stop Typing but available for other operations).

Output

The node outputs a JSON object representing the response from the WAHA API after attempting to stop the typing indicator. This typically includes confirmation of the action or error details if the request failed.

No binary data is output by this operation.

Example output structure:

{
  "success": true,
  "message": "Typing indicator stopped"
}

or in case of error:

{
  "error": "Error message describing what went wrong"
}

Dependencies

  • Requires an active WAHA API credential with a valid base URL and API key.
  • Optionally uses an additional API key credential for N8N Tools API validation.
  • The node sends HTTP requests to the WAHA API endpoints.
  • Proper WhatsApp session must be active and identified by the session name.

Troubleshooting

  • Invalid Credentials: If the API key or subscription is invalid, the node will throw 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 selected. Ensure "Message" resource and "Stop Typing" operation are chosen.
  • Chat ID Format: The chat ID must be correctly formatted as a phone number with @c.us or a group ID with @g.us. Incorrect format may cause failures.
  • Session Not Active: If the specified WhatsApp session is not active or connected, the API call will fail. Confirm the session status before using this operation.
  • Network Issues: Connectivity problems to the WAHA API endpoint will result in request failures. Check network and API availability.

Links and References

Discussion