ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve information about a Help Center portal associated with a specific account. It is useful for scenarios where you need to programmatically access or display details of a customer support portal, such as integrating portal data into dashboards, automating support workflows, or syncing portal information with other systems.

For example, you might use this node to fetch the portal configuration or metadata for a given account ID to customize user experiences or monitor portal status.

Properties

Name Meaning
Account Id The numeric ID of the account whose Help Center portal information you want to retrieve

Output

The node outputs JSON data representing the Help Center portal details for the specified account. This typically includes portal configuration, settings, and metadata as returned by the ChatWoot API. The exact structure depends on the API response but generally contains fields describing the portal's properties.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Internet connectivity to reach the ChatWoot API endpoint.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API may return an error or empty response. Verify the account ID is correct.
  • Authentication Errors: Missing or invalid API authentication token will cause authorization failures. Ensure the API key credential is correctly set up.
  • Network Issues: Connectivity problems can prevent reaching the ChatWoot API. Check network access and proxy settings if applicable.
  • API Changes: If the ChatWoot API changes its schema or endpoints, the node might fail. Keep the node and API version compatible.

Links and References

Discussion