{
  "answers":  {
    "email_address":  "johndoe@example.com",
    "other_variable":  "Example Answer",
    "phone_number":  "+15551234122"
  },
  "created_at":  "2024-07-01T11:29:19+00:00",
  "current_step_id":  "get_insurance",
  "current_step_index":  "7",
  "finalized":  true,
  "flow_label":  "intake_form",
  "responder_uuid":  "85b7133b-84db-486e-b721-7a63f2dde525",
  "variant_label":  "v2",
  "variant_uuid":  "91c67401-bfff-4d72-8055-67dfcb9d4da4"
}

{
  "answers":  "Received Form variable values",
  "created_at":  "Time the form response was received by Formsort",
  "current_step_id":  "Current flow step ID",
  "current_step_index":  "Current flow step index",
  "finalized":  "Is the flow finalized?",
  "flow_label":  "Flow label",
  "responder_uuid":  "Unique form responder ID (v4 UUID)",
  "variant_label":  "Flow variant label",
  "variant_uuid":  "Flow variant unique ID (v4 UUID)"
}

​
Events

​
Triggering Webhook Types

The following event types are associated with the Form Response event payload from Formsort.

  • Formsort Step Completed
{
  "answers":  {
    "email_address":  "johndoe@example.com",
    "other_variable":  "Example Answer",
    "phone_number":  "+15551234122"
  },
  "created_at":  "2024-07-01T11:29:19+00:00",
  "current_step_id":  "get_insurance",
  "current_step_index":  "7",
  "finalized":  true,
  "flow_label":  "intake_form",
  "responder_uuid":  "85b7133b-84db-486e-b721-7a63f2dde525",
  "variant_label":  "v2",
  "variant_uuid":  "91c67401-bfff-4d72-8055-67dfcb9d4da4"
}

{
  "answers":  "Received Form variable values",
  "created_at":  "Time the form response was received by Formsort",
  "current_step_id":  "Current flow step ID",
  "current_step_index":  "Current flow step index",
  "finalized":  "Is the flow finalized?",
  "flow_label":  "Flow label",
  "responder_uuid":  "Unique form responder ID (v4 UUID)",
  "variant_label":  "Flow variant label",
  "variant_uuid":  "Flow variant unique ID (v4 UUID)"
}

​
Schema Field Details

​
Form Response
Event Payload
​
answers
object
required

HI ID PII Received Form variable values

CEL
answers
Example
{
"email_address":  "johndoe@example.com",
"other_variable":  "Example Answer",
"phone_number":  "+15551234122"
}
​
responder_uuid
string
required

Unique form responder ID (v4 UUID)

CEL
responder_uuid
Example
"85b7133b-84db-486e-b721-7a63f2dde525"
​
flow_label
string
required

Flow label

CEL
flow_label
Example
"intake_form"
​
variant_label
string
required

Flow variant label

CEL
variant_label
Example
"v2"
​
variant_uuid
string
required

Flow variant unique ID (v4 UUID)

CEL
variant_uuid
Example
"91c67401-bfff-4d72-8055-67dfcb9d4da4"
​
finalized
bool
required

Is the flow finalized?

CEL
finalized
Example
true
​
created_at
timing.v1.Timestamp
required

Time the form response was received by Formsort

CEL
created_at
Example
"2024-07-01T11:29:19+00:00"
​
current_step_id
string

Current flow step ID

CEL
current_step_id
Example
"get_insurance"
​
current_step_index
string

Current flow step index

CEL
current_step_index
Example
"7"
TrackAppointment