Form Response object

Learn about the Form Response object used by the Automation Framework and Bot v3 API

A Form Response objects is included in a payload when a Khoros Messenger end-user has filled out a chat form.

{  
  "fields":[  
    {  
      "type":"select",
      "name":"meal_selection",
      "label":"Your meal?",
      "select":[  
        {  
          "name":"tacos",
          "label":"Tacos",
          "_id":"5d0d3df79bb5d20010376a89"
        }
      ],
      "_id":"5d0d3df79bb5d20010376a88"
    }
  ],
  "quotedFields":[  
    {  
      "type":"select",
      "name":"meal_selection",
      "label":"Your meal?",
      "selectSize":1,
      "options":[  
        {  
          "name":"pizza",
          "label":"Pizza",
          "_id":"5d0d3de0e7753c0010ef9420"
        },
        {  
          "name":"tacos",
          "label":"Tacos",
          "_id":"5d0d3de0e7753c0010ef941f"
        },
        {  
          "name":"ramen",
          "label":"Ramen",
          "_id":"5d0d3de0e7753c0010ef941e"
        }
      ]
    }
  ]
}

Field

Description

fields

A list of Field Response objects representing choices the user made. See the Brand Messenger SDK documentation for more details about the fields field. (The Brand Messenger SDK is built on top of Smooch.)

quotedFields

A list of Field Request objects representing the original form presented to the user. See the Brand Messenger SDK documentation for more details about the quotedFields field. (The Brand Messenger SDK is built on top of Smooch.)