Actions85
- 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 list instances. It allows users to retrieve a collection of instances, optionally filtered by ID or name. This is useful in scenarios where you need to programmatically access and manage instances from the WaAPI service, such as monitoring active instances, integrating instance data into workflows, or automating instance-related tasks.
For example, you might use this node to:
- Fetch all instances matching a specific name pattern.
- Retrieve details of instances for reporting or auditing purposes.
- Integrate instance data into other systems or processes within an automation workflow.
Properties
| Name | Meaning |
|---|---|
| Filter | Filter instances by ID or name. Accepts a string value used to narrow down the list of instances returned by the API. |
Output
The node outputs JSON data representing the list of instances retrieved from the WaAPI API. Each item in the output corresponds to an instance object containing its details as provided by the API. The exact structure depends on the API response but typically includes identifiers, names, statuses, and other relevant metadata about each instance.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the WaAPI API.
- The node uses the base URL
https://waapi.app/api/v1for API requests. - Proper configuration of the API authentication credential in n8n is necessary for successful operation.
Troubleshooting
Common issues:
- Authentication failures due to missing or invalid API credentials.
- Network connectivity problems preventing access to the WaAPI endpoint.
- Incorrect filter values that result in no instances being returned.
Error messages:
- Errors related to authorization usually indicate issues with the API key; verify that the credential is correctly set up.
- HTTP errors like 404 or 500 suggest problems with the API endpoint or server; check the API status and your request parameters.
- Empty results may mean the filter does not match any existing instances; try broadening or removing the filter.
Links and References
- WaAPI Official Documentation (for detailed API usage and instance data structure)
- n8n Documentation (for general guidance on using API nodes and managing credentials)