Web Chat

Get Webchat Settings

The widget's appearance and behaviour, for one bot and surface.

get/webchat/settings

Request

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

Query parameters

chat_bot_idstring required

Owning chat bot id (UUID). REQUIRED: an org can run several bots and this content belongs to one of them, so it identifies the rows rather than filtering them.

surface'external' | 'internal' nullable

Which widget: external (the customer-facing embed) or internal (graph8's own support widget). Omitted means external.

Headers

Authorizationstring nullable
X-Target-Org-Idstring 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.