How to Capture Pre-Chat Information via API


A Pre-Chat form allows you to gather essential details from your website visitors, including their name, email, phone number, and more before the conversation begins. This information can be utilized to generate potential leads and contacts.

When you enable Pre-Chat user authentication, you can transfer the information provided by visitors through the pre-chat form to any third-party website. This help article will provide instructions on how to capture the pre-chat information using the API.


By Capturing the Pre Chat information using API, the chat operator can:


  • Transfer the pre-chat information to other third-party systems, ensuring a seamless flow of customer information across different platforms
  • Get context about the visitor's query before the conversation begins.
  • Take follow-up with personalized offers, promotions, or important updates


How to Capture Pre-Chat Information via API


Step 1: Log in to your ProProfs Live Chat account and then navigate to  Settings > Advanced > API.


capture pre chat info via api


Step 2: Enable Pre Chat User Authentication using the toggle button, and enter the Host and Script Path.


enble pre chat uathenticationa and enter host and path


Here's the sample input for filling the Host and Script Path field:


Field Name Description
Host The domain name for the script, for example- or
Script Path The path for the script /yourtestscript.php or /yourtestscript.asp etc.

Default: HTTP:// connections are not secure because they exchange credentials and data in clear text, so we recommend using HTTPS.

Secure (Recommended): HTTPS:// connections are secure, encrypting both credentials and information.


Enter all the required values for the hostname, script path, and then select the port.


Step 5: Navigate to the "Check Connection" option to verify the API connection. Then, click on the 'Save' button to save the entered values.


After completing the above steps, the chat transcript details will be automatically sent to the specified path in JSON (JavaScript Object Notation) format.


Example Response [Success] 


Content-Type: application/json
             "visitor_name":    "Test",
             "visitor_email":    "",
             "Phone_Number":     "99999999999"



Note: Each pre-chat form is associated with a particular operator group. The information extracted through the pre-chat form API will vary according to the pre-chat form used.


That's all you need to know about capturing the Pre-Chat information via API in ProProfs Chat. 

If you have any further questions or need assistance during the setup process, feel free to contact our support team.


Thank you for choosing our service, and we hope this article has been helpful in capturing pre-chat information effectively.



© 2005 - 2024 ProProfs
add chat to your website