Skip to content

Create Webchat Agent

POST
/webchat/agents

Map an agent onto the URLs it answers on.

url_filter is matched against the page the widget is embedded on. default: true is the fallback when nothing matches - without one, a visitor on an unlisted page gets no agent.

Authorizations

Parameters

Header Parameters

Idempotency-Key
Any of:
string
>= 16 characters <= 128 characters

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.

X-Target-Org-Id
Any of:
string

Request Body required

Map an AI agent onto the URLs it should answer on.

object
active
boolean
default: true
agent_id
Any of:
string
<= 255 characters
agent_name
required
string
>= 1 characters <= 255 characters
chat_bot_id
required

Owning chat bot id (UUID).

string
default

Used when no URL filter matches.

boolean
surface
Any of:
string
Allowed values: external internal
url_filter

URL paths where this agent is active.

Array<string>

Responses

201

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string