Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Overview
This node interacts with the Conversations API of a chat platform to list all conversations associated with a specific contact within a particular inbox. It is useful for retrieving conversation history or monitoring ongoing interactions between contacts and support agents or chatbots.
Typical use cases include:
- Fetching all conversations for a customer to analyze communication history.
- Integrating conversation data into CRM or helpdesk systems.
- Automating workflows based on conversation status or content.
For example, a support team could use this node to pull all conversations related to a customer’s identifier in a given inbox to review past issues before responding.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier of the inbox channel from which to retrieve conversations. |
| Contact Identifier | The unique source ID of the contact whose conversations are to be listed. |
Output
The node outputs JSON data representing the list of conversations for the specified contact in the given inbox. Each item in the output typically contains details about individual conversations such as conversation IDs, timestamps, statuses, messages, and participants.
If the API supports binary data (e.g., attachments), the node would handle it accordingly, but based on the provided code and properties, the primary output is structured JSON conversation data.
Dependencies
- Requires an API key credential for authenticating with the chat platform's API.
- The base URL for the API must be configured in the node credentials.
- Depends on the external Conversations API endpoint that provides conversation data filtered by inbox and contact identifiers.
Troubleshooting
- Missing or invalid Inbox Identifier or Contact Identifier: The node requires both identifiers to fetch conversations. Ensure these values are correctly obtained and passed.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- API endpoint unreachable or incorrect base URL: Confirm the base URL in credentials matches the chat platform’s API endpoint.
- Empty results: If no conversations are returned, verify that the contact exists in the specified inbox and that there are conversations available.
Links and References
- Chat Platform Conversations API Documentation (example link; replace with actual)
- n8n documentation on creating custom nodes