Skip to main content
Fires when a visitor gives the chat widget their contact details: by filling in the widget’s contact details form, or by answering a form in the widget that asks for a name, an email address or a phone number.

Payload

string
required
The visitor. Always present.
string
The visitor’s name as it stands after this submission, including one given earlier. null when they have never given one.
string
The visitor’s email address, on the same terms as name.
string
The visitor’s phone number, on the same terms as name.

Worth knowing

  • The details are self-reported. They are whatever the visitor typed, and nothing checks them. Treat email as a lead rather than a verified address.
  • Every submission fires it, including one that repeats details the visitor already gave.
  • A blank answer keeps the earlier value. Only the details the visitor filled in are written, so a detail given earlier stays in the payload.
  • Verified visitors never fire it. A visitor your site signs in through widget visitor identity carries details your server vouched for, and the widget refuses to overwrite them from the visitor’s side.
  • No conversation id. The details belong to the visitor across all of their chats. Match visitorId against widget.conversation.started to connect the two.

Example