ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Conversations API → Create A Conversation

AI-generated

Summary

Create a new conversation in ChatWoot by specifying the target inbox and associated contact, with optional custom attributes to include additional metadata in the conversation.

Inputs

  • Inbox Identifier (required) — The identifier of the target inbox channel where the conversation will be created, obtained from the ChatWoot API inbox channel.
  • Contact Identifier (required) — The source ID of the contact associated with the conversation, obtained upon contact creation via the ChatWoot API.
  • Custom Attributes — A JSON object defining custom attributes to attach to the conversation as additional metadata.
  • Request Options — Optional settings influencing the HTTP request behaviour, including batching controls, SSL certificate validation tolerance, proxy settings, and timeout period.

Output shape

a single record containing the newly created conversation details as returned by the ChatWoot API

Supports batch processing of multiple conversations based on request options; the response includes the full data for each created conversation. Errors or API issues will be reflected in the execution result.

Examples

Example 1: Create a conversation for an existing contact in a specific inbox with custom metadata

Set Inbox Identifier and Contact Identifier as required. Provide a JSON object for Custom Attributes if needed.

Discussion