Web Chat

Create Webchat Agent

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.

post/webchat/agents

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/agents
  • 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

chat_bot_idstring required

Owning chat bot id (UUID).

agent_idstring nullable

Agent id from agent settings.

agent_namestring required
url_filterstring[]

URL paths where this agent is active.

activeboolean
defaultboolean

Used when no URL filter matches.

surface'external' | 'internal' nullable

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.