CHchatwoot
AgentBots

Create an Agent Bot

Changed on

Create an agent bot

post/platform/api/v1/agent_bots

Request

  • Base URL
    https://app.chatwoot.com
  • Auth
    • HTTP bearer
    • or API key in header api_access_token

Request body

namestring

The name of the agent bot

descriptionstring

The description of the agent bot

outgoing_urlstring

The webhook URL for the bot

account_idinteger

The account ID to associate the agent bot with

avatarstring binary

Send the form data with the avatar image binary or use the avatar_url

avatar_urlstring

The url to a jpeg, png file for the agent bot avatar

Example request

{
  "name": "My Agent Bot",
  "description": "This is a sample agent bot",
  "outgoing_url": "https://example.com/webhook",
  "account_id": 1,
  "avatar_url": "https://example.com/avatar.png"
}

Response

Success

idnumber

ID of the agent bot

namestring

The name of the agent bot

descriptionstring

The description about the agent bot

thumbnailstring

The thumbnail of the agent bot

outgoing_urlstring

The webhook URL for the bot

bot_typestring

The type of the bot

bot_configobject

The configuration of the bot

account_idnumber

Account ID if it's an account specific bot

access_tokenstring

The access token for the bot

system_botboolean

Whether the bot is a system bot

Changes