Actions18
- Administração Actions
- Instancia Actions
- Perfil Actions
- Webhooks e SSE Actions
- Enviar Mensagem Actions
Overview
This node integrates with the unofficial uazapiGO API to manage WhatsApp instances and configure global webhooks that receive events from all instances. Specifically, the "Administração" resource with the "Configurar Webhook Global" operation allows users to set a global webhook URL and specify which event types should be monitored across all WhatsApp instances managed by the system.
Common scenarios for this node include:
- Centralizing event handling by configuring a single webhook endpoint to receive updates about multiple WhatsApp instances.
- Monitoring various WhatsApp-related events such as messages, calls, contacts, groups, and presence changes globally.
- Automating workflows triggered by WhatsApp events without needing to configure webhooks individually per instance.
Practical example:
- A user wants to receive notifications whenever any message or call event occurs on any WhatsApp instance managed by their system. They use this node to set a global webhook URL and select the "Messages" and "Call" events to monitor.
Properties
| Name | Meaning |
|---|---|
| Url | Base URL of the uazapiGO API. Default is https://api.uazapigo.com. |
| URL do Webhook | The URL endpoint where webhook events will be sent. Must be a valid HTTPS URL. |
| Eventos | List of event types to monitor globally. Options include: Connection, History, Messages, Messages Update, Call, Contacts, Presence, Groups, Labels, Chats, Chat Labels, Blocks, Leads, Sender. |
Output
The node outputs an array of JSON objects representing the response from the uazapiGO API after setting the global webhook configuration. The structure depends on the API's response but generally includes confirmation of the webhook URL and the list of events registered.
No binary data output is produced by this operation.
Example output JSON snippet:
{
"url": "https://meusite.com/webhook",
"events": ["messages", "call", "contacts"]
}
Dependencies
- Requires access to the uazapiGO API.
- Requires an admin-level API token credential to authenticate requests related to administration operations.
- The base API URL can be customized but defaults to
https://api.uazapigo.com. - No additional environment variables are explicitly required beyond the API token credential.
Troubleshooting
- Missing Admin Credentials: If the admin API token is not provided or invalid, the node will throw an error indicating that admin credentials were not found. Ensure the correct API key credential is configured in n8n.
- Invalid Webhook URL: The webhook URL must be a valid HTTPS URL. Omitting the protocol or using HTTP may cause errors or rejected requests.
- Empty Events List: Setting no events to monitor might result in the webhook not receiving any data. Always select at least one event type.
- API Request Failures: Network issues or incorrect API URLs can cause request failures. Verify connectivity and the correctness of the base URL.
- Continue On Fail Behavior: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.
Links and References
- uazapiGO Official API Documentation (Unofficial) (Note: This is inferred from the default URL; verify actual docs separately.)
- n8n Documentation on Creating Custom Nodes
- General information on Webhook Concepts
If you need further details on other operations or resources, feel free to ask!