Web Chat

Create Chat Bot

Create a chat bot.

agent_id seeds the bot with an answering agent. Omitted, the bot is created with none and answers nothing until an agent is mapped with POST /webchat/agents.

post/webchat/chat-bots

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/chat-bots
  • Auth: HTTP bearer

Headers

Idempotency-Keystring nullable

Retry-safety key for this create. Replaying the same key returns the FIRST result instead of creating a second row. Durability depends on the tenant's migration state, so treat it as best-effort.

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required
agent_idstring nullable

Optional voice/text agent id used to seed the new bot's external chat agent. When omitted, no agent row is created.

agent_namestring nullable

Display name of the selected agent. Stored on the agent row so the widget shows the AGENT's name, not the bot's. Falls back to the bot name when omitted.

Response

Successful Response

dataWebchatPayload required

An open envelope for one webchat object.

Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.

Changes

No recorded changes to this operation across all 2 revisions of this API.