WaAPI icon

WaAPI

Interact with WaAPI API

Actions85

Overview

This node interacts with the WaAPI service to retrieve chat data. Specifically, the "Get Chats" operation fetches a list of chat instances from the API based on provided parameters such as instance ID, offset, and limit. This is useful for workflows that need to process or analyze chat conversations, monitor chat activity, or integrate chat data into other systems.

Practical examples include:

  • Fetching recent chat sessions for customer support analysis.
  • Retrieving chat history for archiving or reporting purposes.
  • Integrating chat data into CRM or analytics platforms.

Properties

Name Meaning
Id The unique identifier of the chat instance to retrieve. Required to specify which chat(s) to get.
Offset Number of items to skip before starting to collect the result set. Useful for pagination.
Limit Maximum number of chat items to return in one request. Controls the size of the result set.

Output

The node outputs JSON data representing the retrieved chat instances. Each item in the output corresponds to a chat record fetched from the WaAPI service. The structure typically includes details about each chat session such as identifiers, timestamps, participants, messages, or metadata depending on the API response.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the WaAPI service.
  • The node sends requests to https://waapi.app/api/v1.
  • Proper configuration of the API key credential within n8n is necessary for successful operation.

Troubleshooting

  • Common issues:
    • Invalid or missing API key credential will cause authentication failures.
    • Providing an invalid or non-existent chat instance ID may result in empty results or errors.
    • Exceeding API rate limits could lead to temporary blocking or error responses.
  • Error messages:
    • Authentication errors usually indicate problems with the API key; verify the credential setup.
    • Validation errors may occur if required properties like "Id" are missing or incorrectly formatted.
    • Network or timeout errors suggest connectivity issues with the WaAPI endpoint.

Links and References

Discussion