Skip to main content

Add Form Response

The ADD_FORM_RESPONSE event is triggered whenever new form response added in the case.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be `ADD_FORM_RESPONSE`.
payloadobject
The main object containing all data related to the form submission.
Show child attributes
formobject
An object containing metadata about the form that was submitted.
Show child attributes
idstring<UUID>
The unique identifier for the form template.
namestring
The name of the form.
descriptionstring
A brief description of the form's purpose.
responsearray<object>
A list of response objects, where each object represents a single answered question from the form.
Show child attributes
idstring<UUID>
The unique identifier for this specific answer.
isArchivedboolean
Indicates if the response has been archived.
questionobject
An object containing the full details of the question that was asked.
Show child attributes
indexinteger
The numerical order of the question in the form.
typestring
Allowed values:TEXT,SINGLESELECT,MULTISELECT,DATE,FILE,BOOLEAN,DATERANGE,STATEMENT,WIDGET_STATE_PICKER,WIDGET_BMI,WIDGET_VISIT_TYPE,WIDGET_USER_ID_DOCUMENT
The type of form field used for the question.
textstring
The full text of the question presented to the user.
isPHIboolean
Indicates if the question asks for Protected Health Information (PHI).
optionsarray<string>
A list of possible answer choices for `SINGLESELECT` or `MULTISELECT` questions.
requiredboolean
Indicates if the question was mandatory.
textstring
The answer provided by the user. For `MULTISELECT` questions, this will be a JSON-formatted string array.
createdAtstring<date-time>
The ISO 8601 timestamp of when the response was submitted.
respondentobject
An object containing identifying details of the user who submitted the form.
Show child attributes
idstring<UUID>
The unique identifier of the respondent.
firstNamestring
The first name of the respondent.
lastNamestring
The last name of the respondent.
caseobject
An object containing the full details of the case at the time of the event.
Show child attributes
idstring<UUID>
The unique identifier for the case.
typestring
The type or category of the case (e.g., "GLP").
titlestring
The title of the case.
statusstring
Allowed values:OPEN,ASSIGNED,IN_PROGRESS,APPROVED,REJECTED,NO_DECISION
The current status of the case.
shortIdstring
A short, human-readable identifier for the case.
createdAtstring<date-time>
The timestamp when the case was created.
updatedAtstring<date-time>
The timestamp when the case was last updated.
assignedAtstring<date-time>
The timestamp when an assignee was first added to the case.
inProgressAtstring<date-time>
The timestamp when the case status changed to "IN_PROGRESS".
closedAtstring<date-time>
The timestamp when the case was closed. null if still open.
isArchivedboolean
Indicates if the case is closed/archived.
isEscalatedboolean
Indicates if the case is escalated.
isImportedboolean
Indicates if the case is imported from outside.
referralCodestring
Indicates if user have any referralCode.
closedBystring
The unique identifier for the user that case mark close.
inProgressBystring
The unique identifier for the user which make case in InProgress.
organizationIdstring<UUID>
The unique identifier for the case belongs which organization.
archiveReasonstring
Indicates if the case is archived any reason for it, null if still open.
productBundleobject
Details about the product bundle associated with the case.
Show child attributes
namestring
Indicates case product bundle name.
submitterobject
An object containing the details of the user who submitted the case.
Show child attributes
idstring
The unique identifier of the submitter.
firstNamestring
The first name of the submitter.
lastNamestring
The last name of the submitter.
emailstring
The email address of the submitter.
dobstring<date-time>
The date of birth of the submitter in ISO 8601 format.
genderstring
The gender of the submitter (e.g., MALE, FEMALE, OTHER).
phoneNumberstring
The phone number of the submitter, including country code.
addressstring
The primary address line of the submitter.
address2string
The secondary address line of the submitter, if applicable.
citystring
The city of the submitter's address.
statestring
The state or province of the submitter's address.
postalCodestring
The postal code of the submitter's address.
activityobject
An object that describes the specific action that triggered this webhook.
Show child attributes
idstring<UUID>
The unique identifier for this activity log entry.
typestring
Allowed values:CREATE_CASE,CHANGE_CASE_STATUS,ADD_CASE_COMMENT,DELETE_CASE_COMMENT,ADD_CASE_DECISION,ARCHIVE_CASE,ESCALATE_CASE,DEESCALATE_CASE,ADD_CASE_ESCALATION,REMOVE_CASE_ESCALATION,UPDATE_CASE_ESCALATION,DECISION_DELETED,ADD_CASE_ATTACHMENT,ADD_CASE_ASSIGNEE,REMOVE_CASE_ASSIGNEE,IMPORT_CASE,ADD_FORM_RESPONSE,UPDATE_FORM_RESPONSE,ADD_HR_REP,REMOVE_HR_REP,DELETE_ATTACHMENT,FOLLOWUP_EMAIL,PAYMENT_ADDED,PAYMENT_COMPLETED,PAYMENT_DELETED,PAYMENT_UPDATED,ORDER_CREATED,TEXT_INFO,REOPEN_CASE,SMS_SENT,SMS_RECEIVED,INBOUND_EMAIL,OUTBOUND_EMAIL,FOLLOWUP_FORM,ORDER_STATUS_CHANGED,ORDER_TRACKING_ADDED,PAYMENT_INFO_LINK_SENT,ADD_PAYMENT_INFO_USING_LINK,CALENDAR_EVENT_CREATED,CALENDAR_EVENT_RESCHEDULED,CALENDAR_EVENT_CANCELED,CALENDAR_EVENT_NO_SHOW,CALENDAR_EVENT_NO_SHOW_REMOVED,SUPPORT_NOTE_ADDED,SUPPORT_NOTE_UPDATED,SUPPORT_NOTE_COMPLETED,COMMENT_ACKNOWLEDGED,NOTE_ACKNOWLEDGED,VISIT_TYPE_CHANGED,PAYMENT_PREAUTHORIZED,SUBSCRIPTION_ADDED,SUBSCRIPTION_ACTIVATED,SUBSCRIPTION_COMPLETED,SUBSCRIPTION_PAUSED,SUBSCRIPTION_RESUMED,SUBSCRIPTION_CANCELLED,SUBSCRIPTION_UPDATED
The type of activity.
timestampstring<date-time>
The exact timestamp when the activity occurred.
actorobject
The user who performed the action (i.e., who added the new assignee).
Show child attributes
idstring<UUID>
The ID of the actor.
firstNamestring
The first name of the actor.
lastNamestring
The last name of the actor.
emailstring
The email of the actor.
targetUserobject
The user who was the target of the action (i.e., the user who was assigned).
Show child attributes
idstring<UUID>
The ID of the assigned user.
firstNamestring
The first name of the assigned user.
lastNamestring
The last name of the assigned user.
emailstring
The email of the assigned user.

Response​

{
  "event": "ADD_FORM_RESPONSE",
  "payload": {
    "form": {
      "id": "8ce39d89-a603-4aff-a9fd-b876e21278c9",
      "name": "Copy of Weight Loss Eligibility Intake Form",
      "description": ""
    },
    "response": [
      {
        "id": "1188c9cd-76c1-4a40-81cd-04774e3f382d",
        "isArchived": false,
        "question": {
          "index": 1,
          "type": "TEXT",
          "text": "First Name",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "hk",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "2b62a071-a7a4-4ee1-bc84-5cf5d06f612b",
        "isArchived": false,
        "question": {
          "index": 2,
          "type": "TEXT",
          "text": "Last Name",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "nk",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "9616f2c6-438b-4fda-9161-fcb2ee8ec68f",
        "isArchived": false,
        "question": {
          "index": 3,
          "type": "SINGLESELECT",
          "text": "What was your gender at birth?",
          "isPHI": false,
          "options": [
            "Male",
            "Female",
            "Other"
          ],
          "required": true
        },
        "text": "Male",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "a4016ac1-7f00-4c09-a6ec-8c5a3a6f4ec0",
        "isArchived": false,
        "question": {
          "index": 4,
          "type": "TEXT",
          "text": "What is your age?",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "21",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "318e4480-1d95-4f4a-8820-a6c4c28758dd",
        "isArchived": false,
        "question": {
          "index": 5,
          "type": "TEXT",
          "text": "What is your height (ft, in)?",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "12 ft",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "7ea622df-1487-4f5f-be42-e87220b60d8d",
        "isArchived": false,
        "question": {
          "index": 6,
          "type": "TEXT",
          "text": "How much do you weigh?",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "12kg",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "c9d62dcf-afd1-42b2-b23d-9aba17728278",
        "isArchived": false,
        "question": {
          "index": 7,
          "type": "MULTISELECT",
          "text": "Do you have any of the following symptoms? (select all that apply)",
          "isPHI": false,
          "options": [
            "High Cholesterol",
            "Fatty Liver Disease",
            "High Blood Pressure",
            "Pre Diabetes/ Type 2 Diabetes/ Hbac 1 above 5.7",
            "none of the above",
            "other"
          ],
          "required": true
        },
        "text": "[\"none of the above\"]",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "31a268cb-c865-4348-9e6b-599783b6946b",
        "isArchived": false,
        "question": {
          "index": 8,
          "type": "MULTISELECT",
          "text": "Do you have any of the following symptoms? (select all that apply)",
          "isPHI": false,
          "options": [
            "Medullary Thyroid Cancer (MTC) or family history of MTC or Multiple endocrine neoplasia Type 2 or any cancer",
            "Multiple Endocrine Neoplasia Syndrome Type 2 (MEN 2)",
            "Serious Allergic reaction to Semaglutide or Tirzepitide or compounded components",
            "Active Cancer",
            "Active Drug or Alcohol Misuse",
            "Eating disorders",
            "Bipolar Disorder",
            "Schizophrenia",
            "Pancreatitis",
            "Diabetes mellitus type 1 or Insulin dependent type 2 DM",
            "Any liver or Kidney disease",
            "Active gallbladder disease",
            "Chronic or persistent hypoglycemia with ranges < 60 mg/dl",
            "Pregnant or planning to become pregnant in the next 2 months",
            "None of the above"
          ],
          "required": true
        },
        "text": "[\"Eating disorders\",\"Serious Allergic reaction to Semaglutide or Tirzepitide or compounded components\"]",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "d07ca852-d5ed-4515-a8dd-1b39649153e3",
        "isArchived": false,
        "question": {
          "index": 9,
          "type": "SINGLESELECT",
          "text": "What are your weight loss goals?",
          "isPHI": false,
          "options": [
            "Lose 1-20lbs for good ",
            "Lose 21-50lbs for good",
            "Lose over 50 for good ",
            "Maintain my healthy weight",
            "None of the above",
            "other"
          ],
          "required": true
        },
        "text": "Maintain my healthy weight",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "7a8a7ec8-ea2a-4c58-99f4-9cb620c2b208",
        "isArchived": false,
        "question": {
          "index": 10,
          "type": "DATE",
          "text": "Date of Birth",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "2025/09/04",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "79d7bc2f-6bc2-44b8-af1e-3fe56f88d7e9",
        "isArchived": false,
        "question": {
          "index": 11,
          "type": "TEXT",
          "text": "Email Address",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "ritik.parikh+45@carevalidate.com",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "9b70e0a5-7343-43f0-8dae-3f5be53d3090",
        "isArchived": false,
        "question": {
          "index": 12,
          "type": "TEXT",
          "text": "Phone number",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "+12287474731",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "81030b1c-6d31-45d6-a743-4f1e93ad1746",
        "isArchived": false,
        "question": {
          "index": 13,
          "type": "TEXT",
          "text": "Shipping Address",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "hjbgwj, NY, Raj",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "e76012f9-5b37-4dbb-a043-9b8b918a4d98",
        "isArchived": false,
        "question": {
          "index": 14,
          "type": "MULTISELECT",
          "text": "What weight loss initiatives have you tried in the past? (select all that apply)",
          "isPHI": false,
          "options": [
            "Exercise",
            "Dieting",
            "Weight-loss Supplements ",
            "Intermittent Fasting",
            "Other GLP1's",
            "Other"
          ],
          "required": true
        },
        "text": "[\"Dieting\"]",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      },
      {
        "id": "86b2d9c3-0ce5-4b6d-9b1e-45f579e1193d",
        "isArchived": false,
        "question": {
          "index": 15,
          "type": "FILE",
          "text": "Please upload a government issued form of ID (Driver's License, Passport, etc). Please be sure that your full name and photo are easily visible.",
          "isPHI": false,
          "options": [],
          "required": true
        },
        "text": "personal/vkF2O8QuF5ORPHGMoJ1kqcEth9y1/logo.png",
        "createdAt": "2025-09-04T00:17:32.899Z",
        "respondent": {
          "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
          "firstName": "Ritik-45",
          "lastName": "p-45"
        }
      }
    ],
    "case": {
      "id": "e79f781e-a5db-4757-9bbb-9648831a6ff8",
      "type": "GLP",
      "title": "Case for Ritik-45 p-45",
      "status": "IN_PROGRESS",
      "shortId": "ADA-H7GXC",
      "createdAt": "2025-06-25T11:21:14.395Z",
      "updatedAt": "2025-09-04T00:17:32.923Z",
      "assignedAt": "2025-06-25T11:21:14.955Z",
      "inProgressAt": "2025-07-17T16:01:20.239Z",
      "closedAt": "2025-07-17T15:48:47.851Z",
      "isArchived": false,
      "isEscalated": true,
      "isImported": false,
      "referralCode": null,
      "closedBy": "YaM948FdwiQa3Ek3GCnYsnZTTSW2",
      "inProgressBy": "YaM948FdwiQa3Ek3GCnYsnZTTSW2",
      "organizationId": "652f45e9-eb17-4955-8197-4170e375327f",
      "archiveReason": null,
      "productBundle": null,
      "submitter": {
        "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
        "firstName": "Ritik-45",
        "lastName": "p-45",
        "email": "ritik.parikh+45@carevalidate.com",
        "dob": null,
        "gender": null,
        "phoneNumber": "",
        "address": "1271 6th Avenue",
        "address2": null,
        "city": "Alaska",
        "state": "AK",
        "postalCode": "10020"
      }
    },
    "activity": {
      "id": "eca8e305-6ace-4bfe-b0d7-e4c033ff9882",
      "type": "ADD_FORM_RESPONSE",
      "isPHI": false,
      "isRestricted": false,
      "timestamp": "2025-09-04T00:17:32.899Z",
      "valueBefore": null,
      "valueAfter": null,
      "actor": {
        "id": "vkF2O8QuF5ORPHGMoJ1kqcEth9y1",
        "firstName": "Ritik-45",
        "lastName": "p-45",
        "email": "ritik.parikh+45@carevalidate.com"
      },
      "targetUser": null
    }
  }
}