Web Chat

Create Webchat Blog

Add an article card. display_order is ascending; ties break newest-first.

post/webchat/blogs

Request

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

urlstring required
titlestring required
descriptionstring nullable
image_urlstring nullable
pathsstring[]
surface'external' | 'internal' nullable
activeboolean
display_orderinteger

Lower sorts first; ties break newest-first.

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.