Web Chat

Get Webchat Human Availability

When a human is available to take a handed-off conversation.

Unlike the content routes, chat_bot_id is OPTIONAL here: omitting it reads the org-wide default schedule rather than erroring.

get/webchat/human-availability

Request

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

Query parameters

chat_bot_idstring nullable

Chat bot id. OMIT for the org-wide default schedule.

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.