POST/api/public/widget/poll

Polls for new messages since the last check — relevant e.g. when an agent has taken over the conversation via handover and the customer should see the reply in the widget.

Auth & Security

Widget embed token (X-Widget-Token header) + origin allowlist

Idempotent: Yes

Parameters

widget_code(body, string, required)
session_id(body, string, required)
visitor_id(body, string, required)

Example Request

{"widget_code":"...","session_id":"...","visitor_id":"..."}

Example Response

{"ok":true,"data":{"messages":[]}}

Error Codes

400 PARAMS_REQUIREDvisitor_id and/or session_id is missing.

Live Test Proof

Success (200) and negative case (400) verified live.

Chat Widget