ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The ChatWoot - New Conversation node allows you to programmatically create a new conversation in your ChatWoot account. This is useful for automating customer support workflows, integrating external systems (like CRMs or web forms) with ChatWoot, or triggering conversations based on events in other tools.

Practical examples:

  • Automatically open a new support ticket when a user submits a form on your website.
  • Create a conversation from an incoming webhook or API call.
  • Assign new conversations to specific agents or teams based on custom logic.

Properties

Below are the input properties supported by this operation:

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account where the conversation will be created. (Required)
Source Id String Conversation source id. (Required)
Inbox Id String ID of the inbox in which the conversation is created. Allowed types: Website, Phone, Api, Email. (Required)
Contact Id String Contact ID for whom the conversation is created.
Additional Attributes JSON Specify extra attributes like browser information.
Custom Attributes JSON Object to save custom attributes for the conversation (key-value pairs).
Status Options Status of the conversation: Open, Resolved, Pending. Default is "Open".
Assignee Id String Agent ID to assign the conversation to a specific agent.
Team Id String Team ID to assign the conversation to a specific team.
Message JSON The initial message to be sent in the conversation.

Output

The node returns the response from the ChatWoot API after creating the conversation. The output structure typically includes:

{
  "id": 12345,
  "account_id": 1,
  "inbox_id": "10",
  "contact_id": "20",
  "status": "open",
  "assignee_id": "30",
  "team_id": "40",
  "custom_attributes": { /* ... */ },
  "additional_attributes": { /* ... */ },
  "messages": [ /* ... */ ],
  // ...other fields as returned by ChatWoot
}
  • All fields are directly mapped from the ChatWoot API's response for a newly created conversation.
  • If binary data is ever returned (unlikely for this operation), it would represent file attachments or similar content.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Key/Credentials: You must configure n8n credentials named chatwootApi with your ChatWoot API URL and authentication details.
  • n8n Configuration: No special configuration beyond setting up the credentials.

Troubleshooting

Common Issues:

  • Missing Required Fields: If required fields like Account Id, Source Id, or Inbox Id are missing, the node will fail with a validation error.
  • Invalid Credentials: If the ChatWoot API credentials are incorrect or missing, you'll receive an authentication error.
  • Incorrect Data Types: Supplying invalid JSON in fields like Additional Attributes, Custom Attributes, or Message will result in parsing errors.

Common Error Messages:

  • "400 Bad Request": Usually indicates missing or invalid parameters. Double-check required fields and their formats.
  • "401 Unauthorized": Check your API credentials.
  • "404 Not Found": The specified resource (e.g., Inbox Id or Contact Id) does not exist in your ChatWoot account.

How to resolve:

  • Ensure all required fields are filled and correctly formatted.
  • Verify that referenced IDs (Inbox, Contact, etc.) exist in your ChatWoot account.
  • Check your API credentials and endpoint URL.

Links and References

Discussion