Website chat API

Het officiële widget installeer je in de app: Website chat. Deze pagina is voor een eigen chat-UI. Zie OpenAPI, tag inbox.

Authenticatie: header X-Tillor-Inbox-Widget-Key (waarde uit Instellingen > Integraties > Website chat).

Typen

POST /api/orgs/{orgId}/inbox/website/typing
X-Tillor-Inbox-Widget-Key: iwk_xxx
Content-Type: application/json

{
  "visitorId": "vis_…",
  "active": true,
  "visitorName": "Jan",
  "visitorEmail": "jan@voorbeeld.nl",
  "visitorPhone": "+32470123456"
}

• active: true wanneer de bezoeker typt; false wanneer het veld leeg is of de bezoeker stopt (het widget stuurt false na ongeveer 4 seconden zonder input)
• visitorName / visitorEmail / visitorPhone zijn optioneel
• Gebruik hetzelfde visitorId als bij POST …/inbox/website/messages en GET …/inbox/website/messages

Realtime (SSE)

GET /api/orgs/{orgId}/inbox/website/subscribe?visitorId=vis_…
X-Tillor-Inbox-Widget-Key: iwk_xxx
Accept: text/event-stream

Payload-vorm is hetzelfde als org-SSE (event, data, timestamp). Herverbind na verbreking; er is geen resumption.

Het officiële widget gebruikt SSE als primaire laag en haalt GET …/messages elke 5 seconden opnieuw op als fallback (elke 1 seconde met open paneel wanneer SSE even wegvalt). Daardoor worden antwoorden als afgeleverd gemarkeerd zolang de bezoeker op de pagina is.

Bezoekersactiviteit

POST /api/orgs/{orgId}/inbox/website/events
X-Tillor-Inbox-Widget-Key: iwk_xxx
Content-Type: application/json

event: chat_closed, tab_hidden of navigation (bij navigatie ook url).

Widget-SDK

Het snippet, window.TillorInbox en formulierkoppeling staan op Website chat.