ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Account AgentBot → Create an Agent Bot

AI-generated

Summary

Create a new agent bot in a specified ChatWoot account by providing the account ID and optional details like name, description, avatar image or URL, bot configuration, bot type, and webhook URL.

Inputs

  • Account ID (required) — The numeric ID of the ChatWoot account where the agent bot will be created.
  • Additional Options — Optional fields to include in the request such as the agent bot's name, description, avatar (binary or URL), bot configuration JSON, bot type (default is 0 for webhook), and outgoing webhook URL.

Output shape

a single JSON object representing the created agent bot's details

Returns the newly created agent bot object as returned by the ChatWoot API. The response structure depends on the API's standard output, including any properties specified in the request.

Examples

Example 1: Create an agent bot with just the required Account ID

Set Account ID to the target account number; leave all additional options empty.

Example 2: Create an agent bot with a name, description, and avatar URL

Set Account ID and provide name and description strings; set avatar_url to a valid image URL; optionally set bot_type and outgoing_url.

Links

Discussion