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 provide comprehensive WhatsApp automation capabilities. It supports multiple resources such as sessions, messages, chats, contacts, groups, webhooks, and status checks. Specifically, for the Status resource with the Health Check operation, the node performs a system health check on the WAHA API service.

Common scenarios where this node is beneficial include:

  • Monitoring the health and availability of the WAHA API service before performing other WhatsApp automation tasks.
  • Automating WhatsApp messaging workflows that require session management, message sending, chat handling, contact management, group administration, and webhook configuration.
  • Integrating WhatsApp communication into broader automation pipelines with real-time status verification.

Practical example:

  • Before sending bulk messages or managing groups, use the Health Check operation to ensure the WAHA API service is operational, preventing failures in subsequent steps.

Properties

Name Meaning
Additional Fields Optional extra parameters including:
- Filename: Custom filename for media files
- Mimetype: MIME type of the file
- Link Description: Description for link preview
- Link Title: Title for link preview
- Contact Name: Name for contact vCard
- Contact Number: Phone number for contact vCard
- Reaction: Emoji reaction to send (default 👍)
- Limit: Limit number of results (default 100)
- Download Media: Whether to download media files in messages (boolean, default false)

Note: For the Status > Health Check operation, no additional input properties are required beyond these optional fields.

Output

The node outputs a JSON object containing the response from the WAHA API health endpoint. This typically includes information about the system's current health status, such as uptime, service availability, or any relevant diagnostic data returned by the /api/health endpoint.

Example output structure (simplified):

{
  "status": "ok",
  "uptime": 123456,
  "details": {
    "database": "connected",
    "messageQueue": "operational"
  }
}

No binary data is produced by 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 validating subscription via the n8n Tools API.
  • The node makes HTTP requests to the WAHA API endpoints.
  • Proper configuration of credentials in n8n is necessary for authentication and authorization.

Troubleshooting

  • Invalid Subscription or API Key: If the validation request to the n8n Tools API fails with a 401 or 403 error, verify that the API keys and subscriptions are correctly set up and active.
  • Unknown Resource or Operation Errors: These errors occur if unsupported resource or operation values are provided. Ensure the selected resource is "Status" and operation is "Health Check".
  • Network or Connectivity Issues: Failures to reach the WAHA API endpoint may indicate network problems or incorrect base URL configuration.
  • API Response Errors: If the WAHA API returns an error, inspect the error message for details and confirm that the session and other parameters are correct.

To resolve issues:

  • Double-check all credential configurations.
  • Confirm the WAHA API service is running and accessible.
  • Use the Health Check operation itself to verify service health before other operations.

Links and References

Discussion