ChatWoot

Interact with ChatWoot API

Actions113

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

Overview

This node interacts with the Inbox API of a chat or messaging platform to retrieve detailed information about a specific inbox. It is useful when you need to fetch metadata or configuration details of an inbox channel identified by a unique identifier. For example, it can be used to display inbox properties in a dashboard, audit inbox settings, or integrate inbox details into other workflows.

Properties

Name	Meaning
Inbox Identifier	The unique identifier of the inbox channel obtained from the API. This is required to specify which inbox's details to retrieve.

Output

The node outputs JSON data containing the detailed information of the specified inbox. This typically includes all relevant metadata and configuration fields returned by the Inbox API for that particular inbox identifier. The exact structure depends on the API response but generally provides comprehensive inbox details.

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 API must be configured in the node credentials.
The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

Common issues:
- Invalid or missing inbox identifier will cause the API call to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity problems may prevent successful API requests.
Error messages:
- "Inbox identifier is required" — Ensure the inbox identifier property is set.
- "Authentication failed" — Verify the API key and base URL credentials.
- "Resource not found" — Confirm the inbox identifier exists and is correct.

Resolving these usually involves verifying input parameters and credential configurations.

Links and References

ChatWoot API Documentation (for detailed API endpoints and responses)
n8n documentation on creating custom nodes