Skip to main content

ChatWidgetSession

Stored in the chatwidgetsessions collection. createdAt and updatedAt are maintained automatically.

Returned by GET /chat-widget/:id/sessions, PUT /chat-widget/session/:sessionId/intercept.

FieldTypeNotes
companyObjectId -> Companyrequired
widgetObjectId -> ChatWidgetrequired
contactObjectId -> Contactrequired
statusstringdefault active · one of active, closed
handover.statusstringdefault pending · one of pending, done
handover.atdate
handover.byObjectId -> Member
handover.reasonstringone of immediate, delay, manual
handover.dueAtdate
botRestartedAtdate
historyFromdatedefault null
visitor.ipstring
visitor.userAgentstring
visitor.pageUrlstring
visitor.referrerstring
visitor.utmSourcestring
visitor.utmMediumstring
visitor.utmCampaignstring
visitor.utmTermstring
visitor.utmContentstring
lastVisitorMessageAtdate
lastAgentMessageAtdate
startedAtdatedefault now
lastSeenAtdatedefault now
visitsnumberdefault 0
_idObjectIddefault "6a95712f932657988a91c075"
createdAtdateset once
updatedAtdate