Web Chat

Upload Webchat Image

Upload an image for the widget and get back its public URL.

STATELESS: this does not change the widget. Write the returned URL into the theme with PATCH /webchat/settings - headerImageUrlExternal / headerImageUrlInternal for a header, botAvatarCustomUrl for an avatar. The file type is checked from its bytes, not its declared content type.

post/webchat/images

Request

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

Query parameters

purpose'header' | 'avatar'

header (the widget header image) or avatar (the assistant avatar). Only selects where the file is stored.

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.