livechat
livechat

Request Proactive Greeting

Request a proactive greeting for a visitor.

This endpoint is called by the widget after the configured delay when the visitor has been on the page without interaction.

The greeting is:

  1. Generated using AI based on page context
  2. Kept in the session and pushed to the widget over its realtime channel
  3. Written to the database as the chat's first row only when the visitor answers (no thread is made for a visitor who never writes)

Returns success=false with reason if:

  • greeting_sent flag is already set in session
  • proactive_greeting is disabled in widget config
post/api/livechat/public/{widget_key}/proactive-greeting

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/livechat/public/{widget_key}/proactive-greeting
  • Auth: none declared. Required headers: X-Session-Token

Path parameters

widget_keystring required

Headers

X-Session-Tokenstring required

Request body

language_hintstring nullable

Response

Successful Response

successboolean required
message_idstring nullable
reasonstring nullable
is_draftboolean

Changes

No recorded changes to this operation across all 5 revisions of this API.