Search

Including standard and/or custom fields on the launch form through the Web Chat Component

• Click menu Feature Flags in the Web Chat component setup screen
  • Add the property Show Pre Launch Form and select the desired behavior. Choose always or initial if you want the pre launch form to be visible before launching a chat
• Click menu Functionality Configuration in the Web Chat component setup screen
  • Add the property Pre Launch Form Fields (List of fields to show in the pre-launch form)
  • Click button Add Pre Launch Form Field Data (do this for every field you want to add)
    Note: By default you will get Subject, Email, First Name, Last Name in pre launch fields
    • Custom Field Type
    • Name (name of your field)
      • Accepted values for standard fields are: subject, email, firstName, lastName, productId, categoryId, queueId
    • Options - Add Pre Launch Form Field Options (values of the field), in this format:
      {"value": "id of the custom field", "text": "label customer should see"}
    • Relaunch Value: default, keep, clear
    • Required: true or false

Including standard and/or custom fields on the launch form from the Rule Action

• Create a rule
• Enter a Rule Name
• Rule Evaluation Cycle: Once every Page load, On Page Load, On change of JavaScript Variable
• JavaScript Variable (only relevant if you want to trigger the rule based on a JavaScript Variable from your webpage)
  Note: See example syntax for the Rule Action below
• Add Action - Web Chat Load
• Choose Component (the one you created)
• Set Locale - Source (HTML Tag lang Attribute, JavaScript Variable or Value)
• Add Action Web Chat - Reset Pre-Launch From Fields
  • Choose Component (the one you created)
  • Pre Launch Form Fields:
    • Source: Value
    • Value: see example below
      Note: membership_id is a custom field in the below example, the rest are custom fields.  Notice how we pass the options for categoryId and productId to display a drop-down list on the launch form.

Example:
[
  {
    "name": "subject",
    "required": false,
    "relaunchValue": "keep"
  },
  {
    "name": "firstName",
    "required": false,
    "relaunchValue": "default"
  },
  {
    "name": "lastName",
    "required": false,
    "relaunchValue": "default"
  },
  {
    "name": "email",
    "required": false,
    "relaunchValue": "default"
  },
  {
    "name": "membership_id",
    "required": false,
    "relaunchValue": "default"
  },
  {
    "name": "productId",
    "required": false,
    "relaunchValue": "clear",
    "options": [
       {"value": "1", "text": "productname1"},
       {"value": "2", "text": "productname2"},
       {"value": "3", "text": "productname3"}
     ]
  },
  {
    "name": "categoryId",
    "required": false,
    "relaunchValue": "clear",
    "options": [
       {"value": "1", "text": "categoryname1"},
       {"value": "2", "text": "categoryname2"},
       {"value": "3", "text": "categoryname3"}
     ]
  }
]

Related documentation:

• For details on how to prefill fields with visible or hidden values, see Prefill values in WCFS widget. 
• For a complete guide on how to add custom fields, see Using Custom Fields in the Web Chat for Service widget.
• For steps on renaming the labels on the pre-launch form, see Customizing strings and translating WCFS into various languages.