Web Chat

Create Assessment

Create an assessment.

definition is the flow itself and is validated HERE, against the app's own model - so a graph whose start_step_id names a step it does not define is a 422 rather than a dead end a visitor walks into.

Note chat_bot_id is a QUERY parameter on this one and a BODY field on every other webchat create. That is the app's own inconsistency, mirrored rather than tidied: moving it into the body would send the handler a parameter it does not take.

post/webchat/assessments

Request

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

Query parameters

chat_bot_idstring required

Owning chat bot id (UUID).

Headers

Idempotency-Keystring nullable

Retry-safety key. Replaying it returns the FIRST result.

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required
descriptionstring nullable
surface'external' | 'internal' 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.