ChatWoot

Interact with ChatWoot API

Actions113

Account Agent Bots Actions
- List All Account Agent Bots
- Create An Account Agent Bot
- Get Details Of A Single Account Agent Bot
- Delete An Account Agent Bot
- Update An Account Agent Bot
Agents Actions
- Get Account Agents
- Add New Agent To Account
- Delete Agent From Account
- Update Agent In Account
Canned Responses Actions
- Get Account Canned Response
- Add New Canned Response To Account
- Delete Canned Response From Account
Canned Response Actions
- Update Canned Response In Account
Custom Attributes Actions
- Get Account Custom Attribute
- Add New Custom Attribute To Account
- Get Details Of A Single Custom Attribute
- Delete Custom Attribute From Account
- Update Custom Attribute In Account
Contacts Actions
- Contact List
- Contact Create
- Contact Details
- Contact Update
- Contact Delete
- Contact Conversations
- Contact Search
- Contact Filter
Contact Actions
- Contact Inbox Creation
- Contactable Inboxes Get
Automation Rule Actions
- Get Account Automation Rule
- Add New Automation Rule To Account
- Get Details Of A Single Automation Rule
- Delete Automation Rule From Account
- Update Automation Rule In Account
Help Center Actions
- Get Portal
- Add New Portal To Account
- Update New Portal To Account
- Add New Category To Account
- Add New Article To Account
Conversations Actions
- Conversation List Meta
- Conversation List
- New Conversation
- Conversation Filter
- Get Details Of A Conversation
- Toggle Status Of A Conversation
- Toggle Priority Of A Conversation
Conversation Assignment Actions
- Assign A Conversation
Conversation Labels Actions
- List All Labels Of A Conversation
- Conversation Add Labels
Inboxes Actions
- List All Inboxes
- Get Inbox
- Inbox Creation
- Update Inbox
- Get Inbox Agent Bot
- Update Agent Bot
- Get Inbox Members
- Add New Agent To Inbox
- Delete Agent In Inbox
- Update Agents In Inbox
Messages Actions
- List All Messages
- Create A New Message In A Conversation
- Delete A Message
Integrations Actions
- Get Details Of All Integrations
- Create An Integration Hook
- Delete An Integration Hook
- Update An Integrations Hook
Teams Actions
- List All Teams
- Create A Team
- Get Details Of A Single Team
- Delete A Team
- Update A Team
- Get Team Members
- Add New Agent To Team
- Delete Agent In Team
- Update Agents In Team
Custom Filters Actions
- List All Filters
- Create A Custom Filter
- Get Details Of A Single Custom Filter
- Delete A Custom Filter
- Update A Custom Filter
Webhooks Actions
- List All Webhooks
- Create A Webhook
- Delete A Webhook
- Update A Webhook
Reports Actions
- List All Conversation Statistics
- List All Conversation Statistics Summary
- Get Account Conversation Metrics
- Get Agent Conversation Metrics
Accounts Actions
- Create An Account
- Get Details Of An Account
- Delete An Account
- Update An Account
Account Users Actions
- List All Account Users
- Create An Account User
- Delete An Account User
Agent Bots Actions
- Create An Agent Bot
- Get Details Of A Single Agent Bot
- Delete An Agent Bot
- Update An Agent Bot
Users Actions
- Create A User
- Get Details Of A User
- Delete A User
- Update A User
- Get Sso Url Of A User
Inbox API Actions
- Get Details Of A Inbox
Contacts API Actions
- Create A Contact
- Get Details Of A Contact
- Update A Contact
Conversations API Actions
- List All Contact Conversations
- Create A Conversation
Messages API Actions
- List All Converation Messages
- Create A Message
- Update A Message
CSAT Survey Page Actions
- Get Csat Survey Page

Overview

This node interacts with the ChatWoot API to retrieve detailed information about a specific inbox within a given account. It is useful when you need to programmatically access inbox data such as its configuration, status, or metadata for automation workflows involving customer support or messaging management.

A practical example would be fetching an inbox's details to display in a dashboard or to trigger further actions based on the inbox properties, such as routing messages or analyzing inbox activity.

Properties

Name	Meaning
Account Id	The numeric ID of the ChatWoot account where the inbox resides. This identifies the scope of the inbox.
Id	The unique numeric ID of the inbox to retrieve.

Output

The node outputs JSON data representing the inbox object retrieved from the ChatWoot API. This typically includes all relevant inbox details such as its name, description, status, and any other metadata provided by the API.

No binary data output is expected from this operation.

Dependencies

Requires an API key credential for authenticating with the ChatWoot API.
The base URL for the ChatWoot instance must be configured in the node credentials.
The node depends on the ChatWoot REST API being accessible and the specified account and inbox IDs being valid.

Troubleshooting

Invalid Credentials: If authentication fails, verify that the API key and base URL are correctly set in the node credentials.
Resource Not Found: Errors indicating the inbox or account does not exist usually mean the provided IDs are incorrect or the user lacks permission.
Network Issues: Timeouts or connection errors suggest network problems or incorrect API endpoint URLs.
Missing Required Parameters: Ensure both "Account Id" and "Id" fields are provided and are valid numbers.

Links and References

ChatWoot API Documentation - Official API docs for reference on inbox endpoints and data structure.

ChatWootInstall