Form Response Events

When subscribed to the Form Response events webhook, the following event data will be received:

`event` object

Field name	Description	JSON Type	Data Type
`id`	The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout.	string
`createdDate`	A timestamp signifying when the event was generated. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`type`	Event type: `formResponse`	string
`action`	Event action: `created`	string
`payload`	The payload of the event. The contents of this object depend on the type of event.	object	payload

`payload` object

Field name	Description	JSON Type	Data Type
`responseId`	The response Id	string
`formId`	The form Id	string
`customerId`	The customer Id associated with the form response	string
`businessId`	The business Id that this form response is associated with	string
`businessAlias`	The alias (nickname) of the business	string
`businessGroupId`	The unique identifier for a multilocation group.	string
`appointmentId`	The appointment Id associated with this form response	string
`membershipId`	The membership Id associated with this form response	string
`formTitle`	The title of the form	string
`formPublishedDate`	The date/time that the form was published. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`questionsAndAnswers`	Array of objects with the content containing the questions and answers from the form response	array	questionsAndAnswers

`questionAndAnswers` object

Field name	Description	JSON Type	Data Type
`id`	The question id	numeric	long
`order`	The order in which the question was asked	numeric	int
`questionType`	The question type of the question in the form: `short_answer` `long_answer` `choose_one` `multiple_choise` `dropdown` `scale` `contact_information` `date` Note that the following form question types are *`NOT`* supported: `image` `file_upload` `signature` `payment_information`	string
`question`	The text of the question in the form	string
`answer`	The answers given in the form response. This could contain (1 - n) answers depending on the question asked. *Note:* that for `questionType` : `contact_information` there will always be a string array with six items. If one of the contact items is not required or not filled by the user, it will be an empty string.	array	string

Example

{
	"id": "254FA623-D2B0-4785-A07D-A1A7059C74FF",
	"createdDate": "2024-02-15T00:00:00Z",
	"type": "formResponse",
	"action": "created",
	"payload": {
		"responseId": "Tkhj89234jadkjal23rnjlasfdsakjlewtewt234fw4=",
		"formId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
		"customerId": "681550E7A9CDA57700B419E351D50D80",
		"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
		"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
		"appointmentId": "2dwfErtmMAFxe6hoCnQStw==",
		"membershipId": "344sdSGDE837Hhhs==",
		"formTitle": "Intake form",
		"formPublishedDate": "2023-02-15T00:00:00Z",
		"questionsAndAnswers": [
			{
				"id": 3341,
				"order": 1,
				"questionType": "short_answer",
				"question": "Are you allergic to any hair products?",
				"answer": [
					"No"
				]
			},	
			{
				"id": 5478,
				"order": 2,
				"questionType": "multiple_choice",
				"question": "How would you describe your hair?",
				"answer": [
					"long",
					"curly",
					"oily"
				]
			},
			{
				"id": 5478,
				"order": 3,
				"questionType": "scale",
				"question": "How would you rate your previous appointment?",
				"answer": [
					"8"
				]
			},
			{
				"id": 5478,
				"order": 4,
				"questionType": "contact_information",
				"question": "Please provide your contact information.",
				"answer":[
					"John",
					"",
					"4430 Rosewood Drive, Dublin, CA 94568",
					"[email protected]",
					"+1(123)456-7890",
					"male",
					"",
					""			
				]
			}	
		]
	}
}

event object

payload object

questionAndAnswers object

Example

`event` object

`payload` object

`questionAndAnswers` object