ChatWootInstall

Summary

Create a new conversation in a specific ChatWoot account and inbox, optionally assigning it to a contact, agent, or team, and sending an initial message.

Inputs

• Account Id (required) — The numeric ID of the ChatWoot account where the conversation is to be created.
• Source Id (required) — Identifier representing the source of the conversation.
• Inbox Id (required) — ID of the inbox (Website, Phone, API, or Email) where the conversation is created.
• Contact Id — Optional contact ID for whom the conversation is created.
• Additional Attributes — JSON object specifying extra attributes like browser information.
• Custom Attributes — JSON object to save custom attributes as key-value pairs for the conversation.
• Status — Set the conversation status to open, pending, or resolved; defaults to open.
• Assignee Id — Agent ID to assign the conversation to a specific agent.
• Team Id — Team ID to assign the conversation to a specific team.
• Message — JSON object defining the initial message template parameters to send with the conversation.
• Request Options — Advanced HTTP request options like batching, timeout, proxy, and SSL settings.

Output shape

a single record representing the newly created conversation object as returned by the ChatWoot API

The response includes all properties of the created conversation; the operation expects valid JSON for the message, custom, and additional attributes if specified. Errors or authentication issues yield standard API error responses.

Examples

Example 1: Creating a new conversation with initial message and assigning to an agent

Set Account Id, Inbox Id, Source Id, optional Contact Id, specify Message JSON with template parameters, set Assignee Id, and optionally Custom Attributes and Status.