ChatWidget

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

Returned by DELETE /chat-widget, GET /chat-widget, POST /chat-widget, GET /chat-widget/:id, PUT /chat-widget/:id, PUT /chat-widget/:id/rotate-token and 1 more.

Field	Type	Notes
company	ObjectId -> Company
token	string	unique
name	string	required
description	string
status	string	default draft · one of draft, published, paused
allowedDomains	string[]	default []
preChat.name	object	default {"enabled":true,"required":false,"label":"Name","placeholder":"Your name"}
preChat.name.enabled	boolean	default true
preChat.name.required	boolean	default false
preChat.name.label	string
preChat.name.placeholder	string
preChat.email	object	default {"enabled":true,"required":true,"label":"Email","placeholder":"you@company.com"}
preChat.email.enabled	boolean	default true
preChat.email.required	boolean	default false
preChat.email.label	string
preChat.email.placeholder	string
preChat.contactNumber	object	default {"enabled":true,"required":false,"label":"Phone","placeholder":"Phone number"}
preChat.contactNumber.enabled	boolean	default true
preChat.contactNumber.required	boolean	default false
preChat.contactNumber.label	string
preChat.contactNumber.placeholder	string
preChat.intro	string	default Tell us how to reach you and we'll start the chat.
preChat.submitLabel	string	default Start chat
preChat.consentText	string
verification.email	boolean	default false
verification.contactNumber	boolean	default false
appearance.primaryColor	string	default #4f46e5
appearance.textColor	string	default #ffffff
appearance.position	string	default bottom-right · one of bottom-right, bottom-left
appearance.offsetX	number	default 20
appearance.offsetY	number	default 20
appearance.launcherLabel	string	default ""
appearance.title	string	default Chat with us
appearance.subtitle	string	default We typically reply in a few minutes
appearance.greeting	string	default Hi there! How can we help?
appearance.avatarUrl	string
appearance.showBranding	boolean	default true
handover.showChatBeforeHandover	boolean	default true
handover.interceptChatByHuman	boolean	default true
handover.mode	string	default any · one of any, all
handover.rules	object[]	default []
handover.rules.type	string	required · one of immediate, delay
handover.rules.delayMinutes	number	default 5
handover.rules.enabled	boolean	default true
behaviour.autoOpenDelayMs	number	default 0
behaviour.offlineMessage	string	default We're offline right now — leave a message and we'll get back to you.
behaviour.soundOnMessage	boolean	default true
behaviour.showPreviousChat	boolean	default true
stats.conversations	number	default 0
stats.messages	number	default 0
stats.lastMessageAt	date
createdBy	ObjectId -> Member
updatedBy	ObjectId -> Member
isDeleted	boolean	default false
_id	ObjectId	default "6a95712f932657988a91c074"
createdAt	date	set once
updatedAt	date