N8N Tools - Uazapi icon

N8N Tools - Uazapi

Complete Uazapi integration - Premium WhatsApp API with advanced messaging and automation

Actions37

Overview

This node integrates with the Uazapi WhatsApp API, enabling users to manage and automate WhatsApp messaging and instance operations within n8n workflows. Specifically, the Instance - Get Status operation retrieves the current connection status of a WhatsApp instance managed by Uazapi.

Common scenarios for this node include:

  • Monitoring the health and connectivity of a WhatsApp instance before sending messages.
  • Automating workflows that depend on the instance being online or ready.
  • Integrating WhatsApp status checks into broader communication or alerting systems.

For example, a user might set up a workflow that periodically checks the WhatsApp instance status and triggers notifications if the instance is disconnected or requires attention.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request. Includes:
- Reply to Message ID: ID of a message to reply to (string)
- Delay (seconds): Delay before sending a message (number)
- Disable Link Preview: Whether to disable link previews in messages (boolean)
- Mention Users: Comma-separated phone numbers to mention in the message (string)

Note: For the Instance - Get Status operation, only the "Additional Fields" collection is available as input properties, but typically no additional fields are required for this operation.

Output

The node outputs a JSON object containing the response from the Uazapi API about the WhatsApp instance status. This includes details such as whether the instance is connected, its current state, and possibly other metadata related to the instance's health.

The output structure is:

{
  "json": {
    // Response data from Uazapi instance status endpoint
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an active Uazapi API credential configured in n8n, including:

    • An API key credential for authentication.
    • API URL endpoint.
    • API token for bearer authorization.
    • Instance ID identifying the specific WhatsApp instance.

  • The node sends requests through a proxy service hosted at https://n8ntools.io/api/v1/proxy/uazapi which requires an API key for access.

  • Proper configuration of these credentials and network access to the proxy and Uazapi endpoints is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect instance ID may result in errors or empty status responses.
    • Network issues or proxy unavailability can cause request timeouts or failures.

  • Error Messages:

    • Errors returned from the API are captured and returned in the output JSON under an error field if "Continue On Fail" is enabled.
    • Typical error messages include authentication errors ("Unauthorized"), invalid parameters, or instance not found.

  • Resolution Tips:

    • Verify that all credential fields (API key, token, instance ID) are correctly set.
    • Ensure the WhatsApp instance is properly registered and active in Uazapi.
    • Check network connectivity and proxy service availability.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion