Web Chat

Create Webchat Question

Offer a preset question in the widget.

placements NULL or empty means EVERY placement, not none.

post/webchat/questions

Request

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

questionstring required
categorystring nullable
pathsstring[]
activeboolean
surface'external' | 'internal' nullable

NULL shows it on BOTH widgets.

placementsstring[] nullable

NULL or [] means every placement.

sort_orderinteger nullable

Order within a placement. NULL sorts last.

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.