Web Chat

Create Webchat Button

Add a quick-action button.

value is read according to action: a URL for link, the question text for question, a calendar slug for calendar.

post/webchat/buttons

Request

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

labelstring required
action'link' | 'question' | 'calendar' required
valuestring required

URL for link, question text for question, slug for calendar.

iconstring nullable
categorystring required
pathsstring[]

URL paths where the button appears.

activeboolean
surface'external' | 'internal' nullable

NULL shows it on BOTH widgets.

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.