UAZAPI icon

UAZAPI

Integração com a API UAZAPI para WhatsApp Business

Actions3

Overview

This node integrates with the UAZAPI service for WhatsApp Business, enabling automation of administrative and messaging tasks. Specifically, the "Administração" resource with the "Criar Instância" operation allows users to create a new WhatsApp instance within their UAZAPI account. This is useful for setting up new WhatsApp business instances programmatically without manual intervention in the UAZAPI dashboard.

Practical examples include:

  • Automatically provisioning new WhatsApp instances when onboarding new clients.
  • Creating isolated WhatsApp environments for different departments or projects.
  • Integrating instance creation into larger workflows that manage WhatsApp communications.

Properties

Name Meaning
Nome Da Instância The name to assign to the new WhatsApp instance being created. This is a required string input.

Output

The node outputs JSON data representing the response from the UAZAPI server after attempting to create the instance. The output JSON typically contains details about the newly created instance or an error message if the creation failed.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "status": "string",
  "token": "string",
  ...
}

If the API returns a plain string message, it will be wrapped as { "message": "...", "raw": "..." }. If no response is returned, the node outputs { "success": true } by default.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential with administrative privileges on UAZAPI (referred generically as "an API key credential").
  • The credential must include a valid subdomain and admin token to authenticate requests.
  • The node makes HTTP requests to the UAZAPI endpoint constructed using the provided subdomain.
  • Proper configuration of these credentials in n8n is mandatory for the node to function.

Troubleshooting

  • Missing Credentials Error: If the node throws an error indicating missing credentials, verify that the administrative API key credential is correctly configured with the necessary subdomain and token.
  • API Connectivity Issues: Network problems or incorrect subdomain values can cause request failures. Ensure the subdomain is correct and the network allows outbound HTTPS connections.
  • Invalid Instance Name: Providing an empty or invalid instance name may result in API errors. Always provide a meaningful, non-empty string.
  • Unhandled API Errors: If the API returns an error, it will be surfaced in the node output unless "Continue On Fail" is enabled, in which case the error message will appear in the output JSON under error.

Links and References

Discussion