N8N Tools - Uazapi

Overview

This node provides a comprehensive integration with the Uazapi WhatsApp API, enabling advanced messaging and automation capabilities within n8n workflows. It supports sending various types of WhatsApp messages (text, templates, quick replies, lists, locations), managing media files (images, documents, audio, video, stickers), handling contacts and groups, controlling the WhatsApp instance, and configuring webhooks.

Common scenarios where this node is beneficial include:

• Automating customer support by sending interactive WhatsApp messages.
• Broadcasting multimedia content to users.
• Managing WhatsApp contact lists and groups programmatically.
• Monitoring and controlling WhatsApp instance status and settings.
• Integrating WhatsApp messaging into broader business workflows.

Practical examples:

• Sending a text message with buttons for quick user responses.
• Uploading and sending an image with a caption.
• Creating a WhatsApp group and adding participants automatically.
• Setting up a webhook URL to receive incoming WhatsApp events.

Properties

Note: The node supports many other input properties depending on the selected Resource and Operation, such as:

• Phone Number: Target WhatsApp number with country code.
• Message Text: Text content for messages.
• Buttons: Quick reply buttons with text and IDs.
• List Items: Items for interactive list messages.
• Latitude / Longitude / Location Name: For sending location messages.
• Media URL: URL or base64 string of media files.
• Caption / Filename: Optional captions or filenames for media.
• Group ID / Group Name / Participants: For managing WhatsApp groups.
• Webhook URL: URL to configure webhook callbacks.

These inputs are dynamically shown based on the chosen resource and operation.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON contains the response from the Uazapi API for the requested operation.

• The structure varies depending on the operation but generally includes details about the sent message, media upload status, contact info, group info, instance status, or webhook configuration.
• If an error occurs and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.
• The node does not output binary data directly; all responses are JSON-formatted.

Dependencies

• Requires an active Uazapi WhatsApp API account with valid credentials:
  • An API key credential.
  • API URL endpoint.
  • API token for authorization.
  • Instance ID identifying the WhatsApp instance.
• These credentials must be configured in n8n prior to using the node.
• The node makes HTTP requests to the Uazapi service via a proxy endpoint hosted at https://n8ntools.io/api/v1/proxy/uazapi.
• Internet connectivity is required for API communication.

Troubleshooting

• Common Issues:

  • Invalid or missing credentials will cause authentication failures.
  • Incorrect phone numbers or group IDs may result in errors from the WhatsApp API.
  • Network issues can cause request timeouts or failures.
  • Using unsupported operations or resources will throw errors.

• Error Messages:

  • "Unknown resource: ..." indicates an invalid resource parameter.
  • API errors returned from Uazapi will be included in the node output if "Continue On Fail" is enabled.
  • Credential-related errors typically indicate misconfiguration or expired tokens.

• Resolutions:

  • Verify that all required credentials are correctly set up in n8n.
  • Ensure phone numbers and IDs follow the expected formats.
  • Check network connectivity and proxy settings.
  • Use the node's built-in parameter validation and select supported operations/resources.

Links and References

• Uazapi Official Website — For API documentation and account setup.
• WhatsApp Business API Documentation — General WhatsApp API reference.
• n8n Documentation — For guidance on creating and using custom nodes and credentials.