Chatwoot icon

Chatwoot

Interact with Chatwoot API
Join our community

Actions36

Overview

This node integrates with the Chatwoot API to manage various resources such as accounts, contacts, conversations, messages, inboxes, canned responses, webhooks, teams, and labels. Specifically, for the Inbox resource with the Get Many operation, it retrieves a list of inboxes associated with a Chatwoot account.

Typical use cases include:

  • Fetching all inboxes configured in a Chatwoot account to display or process them further.
  • Automating workflows that require inbox data, such as routing messages or analyzing inbox configurations.
  • Synchronizing inbox information with other systems or databases.

Example: You want to retrieve all inboxes from your Chatwoot account to list them in a dashboard or to trigger actions based on inbox properties.

Properties

Name Meaning
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Whether to output detailed request and response logs to the console for debugging purposes.

These properties control error handling behavior and logging verbosity during execution.

Output

The node outputs an array of JSON objects, each representing an inbox retrieved from the Chatwoot API. The structure corresponds directly to the API's inbox payload, typically including fields like inbox ID, name, channel type, and other metadata related to each inbox.

Output example (simplified):

[
  {
    "json": {
      "id": 1,
      "name": "Support Inbox",
      "channel": "Email",
      "created_at": "2023-01-01T12:00:00Z",
      ...
    }
  },
  {
    "json": {
      "id": 2,
      "name": "Sales Inbox",
      "channel": "Facebook",
      "created_at": "2023-02-01T12:00:00Z",
      ...
    }
  }
]

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • Needs the Chatwoot account ID and base URL configured in the credentials.
  • Uses HTTP GET requests to the endpoint /api/v1/accounts/{accountId}/inboxes.
  • Optional debug logging can be enabled to print request details to the console.

Troubleshooting

Common Issues

  • Authentication errors: If the API key or account ID is incorrect or missing, the request will fail.
  • Network issues: Connectivity problems to the Chatwoot server will cause request failures.
  • Invalid base URL: Ensure the base URL does not have trailing slashes or typos.
  • API changes: If Chatwoot updates their API endpoints or response formats, the node might need updating.

Error Messages

  • Errors thrown by the HTTP request helper will include the message from the underlying HTTP client.
  • If debug logging is enabled, detailed error stacks and request info will be printed to help diagnose issues.
  • If "Continue on Fail" is disabled, the node will stop execution on the first error; enabling it allows partial success.

Resolution Tips

  • Verify API credentials and permissions.
  • Check network connectivity and firewall settings.
  • Enable debug logging to get detailed insights.
  • Review Chatwoot API documentation for any breaking changes.

Links and References

Discussion