Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt

Use this file to discover all available pages before exploring further.

images/typeform.svg

​
Events

​
Triggering Webhook Types

The following event types are associated with the Form Submission event payload from Typeform.
  • Typeform Form Submitted
{
  "event_id": "01KBYWTTXW2SXX86TBH2SGNCCS",
  "event_type": "form_response",
  "form_response": {
    "answers": {
      "field_ref_1": "answer_value",
      "field_ref_2": true,
      "field_ref_3": 42
    },
    "answers_detailed": {
      "key": null,
      "value": {
        "boolean": true,
        "choice": {
          "id": "pBVm1w4quPjA",
          "label": "Student",
          "ref": "50a3bd14-b93f-43f6-80c1-94e39aa654ef"
        },
        "choices": {
          "choices": [
            {
              "id": "pBVm1w4quPjA",
              "label": "Student",
              "ref": "50a3bd14-b93f-43f6-80c1-94e39aa654ef"
            }
          ]
        },
        "date": "2025-12-08",
        "email": "foo@gmail.com",
        "field": {
          "id": "OaXBBv3uqDiV",
          "ref": "2e644ba6-3a52-4895-b100-b061c6af0331",
          "type": "short_text"
        },
        "number": 8,
        "phone_number": "123-456-7890",
        "text": "Foo",
        "type": "text",
        "url": "https://morf.health"
      }
    },
    "definition": {
      "endings": [
        {
          "attachment": {
            "href": "https://public-assets.typeform.com/public/admin/2dpnUBBkz2VN.gif",
            "type": "image"
          },
          "id": "DefaultTyScreen",
          "properties": {
            "button_mode": "default_redirect",
            "button_text": "Create a *typeform*",
            "share_icons": false,
            "show_button": true
          },
          "ref": "default_tys",
          "title": "Thanks for completing this typeform",
          "type": "thankyou_screen"
        }
      ],
      "fields": [
        {
          "allow_multiple_selections": true,
          "allow_other_choice": true,
          "choices": [
            {
              "id": "pBVm1w4quPjA",
              "label": "Student",
              "ref": "50a3bd14-b93f-43f6-80c1-94e39aa654ef"
            }
          ],
          "id": "OaXBBv3uqDiV",
          "properties": {},
          "ref": "2e644ba6-3a52-4895-b100-b061c6af0331",
          "title": "What's your first name?",
          "type": "short_text"
        }
      ],
      "id": "V5UCKg7t",
      "settings": {
        "partial_responses_to_all_integrations": true
      },
      "title": "My new form"
    },
    "ending": {
      "attachment": {
        "href": "https://public-assets.typeform.com/public/admin/2dpnUBBkz2VN.gif",
        "type": "image"
      },
      "id": "DefaultTyScreen",
      "properties": {
        "button_mode": "default_redirect",
        "button_text": "Create a *typeform*",
        "share_icons": false,
        "show_button": true
      },
      "ref": "default_tys",
      "title": "Thanks for completing this typeform",
      "type": "thankyou_screen"
    },
    "form_id": "V5UCKg7t",
    "landed_at": "2025-12-08T11:50:39Z",
    "submitted_at": "2025-12-08T11:51:29Z",
    "token": "oe6ruwcl8fzlmvqj5eih5oe6ruwc8vc0",
    "variables": {
      "is_active": true,
      "score": 42,
      "user_id": "12345"
    }
  }
}

{
  "event_id": "Unique event ID",
  "event_type": "Event type",
  "form_response": {
    "answers": "Form answers submitted by the respondent, simplified to be a simple mapping of field references to single values",
    "answers_detailed": {
      "key": null,
      "value": {
        "boolean": "Boolean answer value",
        "choice": {
          "id": "Choice ID",
          "label": "Choice label/text",
          "ref": "Choice reference UUID"
        },
        "choices": {
          "choices": {
            "id": "Choice ID",
            "label": "Choice label/text",
            "ref": "Choice reference UUID"
          }
        },
        "date": "Date answer value (YYYY-MM-DD format)",
        "email": "Email answer value",
        "field": {
          "id": "Field ID this answer corresponds to",
          "ref": "Field reference UUID",
          "type": "Field type"
        },
        "number": "Number answer value",
        "phone_number": "Phone number answer value",
        "text": "Text answer value",
        "type": "Answer type (text, email, phone_number, url, boolean, number, date, choice, choices)",
        "url": "URL answer value"
      }
    },
    "definition": {
      "endings": {
        "attachment": {
          "href": "Attachment URL",
          "type": "Attachment type (e.g., image)"
        },
        "id": "Ending screen ID",
        "properties": {
          "button_mode": "Button mode on ending screen",
          "button_text": "Button text on ending screen",
          "share_icons": "Whether to show share icons on ending screen",
          "show_button": "Whether to show button on ending screen"
        },
        "ref": "Ending screen reference",
        "title": "Ending screen title",
        "type": "Ending screen type"
      },
      "fields": {
        "allow_multiple_selections": "Whether the field allows multiple selections",
        "allow_other_choice": "Whether the field allows 'other' choice",
        "choices": {
          "id": "Choice ID",
          "label": "Choice label/text",
          "ref": "Choice reference UUID"
        },
        "id": "Field ID",
        "properties": "Field properties",
        "ref": "Field reference UUID",
        "title": "Field question/title",
        "type": "Field type (e.g., short_text, email, multiple_choice)"
      },
      "id": "Form definition ID",
      "settings": {
        "partial_responses_to_all_integrations": "Whether partial responses are sent to all integrations"
      },
      "title": "Form title"
    },
    "ending": {
      "attachment": {
        "href": "Attachment URL",
        "type": "Attachment type (e.g., image)"
      },
      "id": "Ending screen ID",
      "properties": {
        "button_mode": "Button mode on ending screen",
        "button_text": "Button text on ending screen",
        "share_icons": "Whether to show share icons on ending screen",
        "show_button": "Whether to show button on ending screen"
      },
      "ref": "Ending screen reference",
      "title": "Ending screen title",
      "type": "Ending screen type"
    },
    "form_id": "Form ID",
    "landed_at": "Time when the respondent landed on the form",
    "submitted_at": "Time when the form was submitted",
    "token": "Response token",
    "variables": "Form variables passed to or set within the form, indexed by variable key"
  }
}

​
Payload Field Details

​
Form Submission
Event Payload