Actions83
- Instances Actions
- Client Actions
- Message Actions
- Chat Actions
- Contact Actions
- Number Actions
- Group Actions
- Channel Actions
- Label Actions
- Story Actions
Overview
This node interacts with the WaAPI API to retrieve the status of a specific client instance. It is useful when you need to monitor or check the current state of a client instance identified by its unique ID. For example, in scenarios where you manage multiple client instances and want to programmatically verify if a particular instance is active, inactive, or has any other status reported by the WaAPI service.
Properties
| Name | Meaning |
|---|---|
| Id | The unique numeric identifier of the client instance whose status you want to retrieve. |
Output
The node outputs JSON data containing the status information of the specified client instance. The exact structure depends on the WaAPI API response but typically includes fields describing the instance's current state, metadata, and possibly timestamps or error messages related to that instance.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the WaAPI API.
- The node makes HTTP requests to
https://waapi.app/api/v1. - Proper configuration of the API authentication credential within n8n is necessary.
Troubleshooting
Common issues:
- Invalid or missing instance ID will likely cause the API to return an error or no data.
- Authentication failures due to incorrect or expired API keys.
- Network connectivity problems preventing access to the WaAPI endpoint.
Error messages:
- Errors related to authorization usually indicate issues with the provided API key; ensure it is valid and has the required permissions.
- "Instance not found" or similar errors suggest the provided ID does not correspond to any existing client instance.
- Timeout or connection errors imply network issues or API downtime.
To resolve these, verify the instance ID, check API credentials, and ensure network connectivity.
Links and References
- WaAPI Official Documentation (for detailed API usage and response formats)
- n8n documentation on HTTP Request Node (for understanding how API calls are made)