POST api/TypeForm/Post

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
event_id	string	None.
event_type	string	None.
form_response	Form_Response	None.

Request Formats

application/json, text/json

Sample:

{
  "event_id": "sample string 1",
  "event_type": "sample string 2",
  "form_response": {
    "form_id": "sample string 1",
    "token": "sample string 2",
    "landed_at": "2024-10-17T11:20:16.8542941+01:00",
    "submitted_at": "2024-10-17T11:20:16.8542941+01:00",
    "definition": {
      "id": "sample string 1",
      "title": "sample string 2",
      "fields": [
        {
          "id": "sample string 1",
          "_ref": "sample string 2",
          "type": "sample string 3",
          "title": "sample string 4",
          "properties": {},
          "allow_multiple_selections": true,
          "choices": [
            {
              "id": "sample string 1",
              "_ref": "sample string 2",
              "label": "sample string 3"
            },
            {
              "id": "sample string 1",
              "_ref": "sample string 2",
              "label": "sample string 3"
            }
          ]
        },
        {
          "id": "sample string 1",
          "_ref": "sample string 2",
          "type": "sample string 3",
          "title": "sample string 4",
          "properties": {},
          "allow_multiple_selections": true,
          "choices": [
            {
              "id": "sample string 1",
              "_ref": "sample string 2",
              "label": "sample string 3"
            },
            {
              "id": "sample string 1",
              "_ref": "sample string 2",
              "label": "sample string 3"
            }
          ]
        }
      ],
      "endings": [
        {
          "id": "sample string 1",
          "_ref": "sample string 2",
          "title": "sample string 3",
          "type": "sample string 4",
          "properties": {
            "description": "sample string 1",
            "button_text": "sample string 2",
            "show_button": true,
            "share_icons": true,
            "button_mode": "sample string 5"
          },
          "attachment": {
            "type": "sample string 1",
            "href": "sample string 2",
            "properties": {
              "description": "sample string 1"
            }
          }
        },
        {
          "id": "sample string 1",
          "_ref": "sample string 2",
          "title": "sample string 3",
          "type": "sample string 4",
          "properties": {
            "description": "sample string 1",
            "button_text": "sample string 2",
            "show_button": true,
            "share_icons": true,
            "button_mode": "sample string 5"
          },
          "attachment": {
            "type": "sample string 1",
            "href": "sample string 2",
            "properties": {
              "description": "sample string 1"
            }
          }
        }
      ]
    },
    "answers": [
      {
        "type": "sample string 1",
        "text": "sample string 2",
        "field": {
          "id": "sample string 1",
          "type": "sample string 2",
          "_ref": "sample string 3"
        },
        "email": "sample string 3",
        "boolean": true,
        "choices": {
          "ids": [
            "sample string 1",
            "sample string 2"
          ],
          "labels": [
            "sample string 1",
            "sample string 2"
          ],
          "refs": [
            "sample string 1",
            "sample string 2"
          ]
        }
      },
      {
        "type": "sample string 1",
        "text": "sample string 2",
        "field": {
          "id": "sample string 1",
          "type": "sample string 2",
          "_ref": "sample string 3"
        },
        "email": "sample string 3",
        "boolean": true,
        "choices": {
          "ids": [
            "sample string 1",
            "sample string 2"
          ],
          "labels": [
            "sample string 1",
            "sample string 2"
          ],
          "refs": [
            "sample string 1",
            "sample string 2"
          ]
        }
      }
    ],
    "ending": {
      "id": "sample string 1",
      "_ref": "sample string 2"
    }
  }
}

application/xml, text/xml

Sample:

<TypeFormObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TypeFormWebhook.Models">
  <event_id>sample string 1</event_id>
  <event_type>sample string 2</event_type>
  <form_response>
    <answers>
      <Answer>
        <boolean>true</boolean>
        <choices>
          <ids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ids>
          <labels xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </labels>
          <refs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </refs>
        </choices>
        <email>sample string 3</email>
        <field>
          <_ref>sample string 3</_ref>
          <id>sample string 1</id>
          <type>sample string 2</type>
        </field>
        <text>sample string 2</text>
        <type>sample string 1</type>
      </Answer>
      <Answer>
        <boolean>true</boolean>
        <choices>
          <ids xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ids>
          <labels xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </labels>
          <refs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </refs>
        </choices>
        <email>sample string 3</email>
        <field>
          <_ref>sample string 3</_ref>
          <id>sample string 1</id>
          <type>sample string 2</type>
        </field>
        <text>sample string 2</text>
        <type>sample string 1</type>
      </Answer>
    </answers>
    <definition>
      <endings>
        <Ending>
          <_ref>sample string 2</_ref>
          <attachment>
            <href>sample string 2</href>
            <properties>
              <description>sample string 1</description>
            </properties>
            <type>sample string 1</type>
          </attachment>
          <id>sample string 1</id>
          <properties>
            <button_mode>sample string 5</button_mode>
            <button_text>sample string 2</button_text>
            <description>sample string 1</description>
            <share_icons>true</share_icons>
            <show_button>true</show_button>
          </properties>
          <title>sample string 3</title>
          <type>sample string 4</type>
        </Ending>
        <Ending>
          <_ref>sample string 2</_ref>
          <attachment>
            <href>sample string 2</href>
            <properties>
              <description>sample string 1</description>
            </properties>
            <type>sample string 1</type>
          </attachment>
          <id>sample string 1</id>
          <properties>
            <button_mode>sample string 5</button_mode>
            <button_text>sample string 2</button_text>
            <description>sample string 1</description>
            <share_icons>true</share_icons>
            <show_button>true</show_button>
          </properties>
          <title>sample string 3</title>
          <type>sample string 4</type>
        </Ending>
      </endings>
      <fields>
        <Field>
          <_ref>sample string 2</_ref>
          <allow_multiple_selections>true</allow_multiple_selections>
          <choices>
            <Choice>
              <_ref>sample string 2</_ref>
              <id>sample string 1</id>
              <label>sample string 3</label>
            </Choice>
            <Choice>
              <_ref>sample string 2</_ref>
              <id>sample string 1</id>
              <label>sample string 3</label>
            </Choice>
          </choices>
          <id>sample string 1</id>
          <properties />
          <title>sample string 4</title>
          <type>sample string 3</type>
        </Field>
        <Field>
          <_ref>sample string 2</_ref>
          <allow_multiple_selections>true</allow_multiple_selections>
          <choices>
            <Choice>
              <_ref>sample string 2</_ref>
              <id>sample string 1</id>
              <label>sample string 3</label>
            </Choice>
            <Choice>
              <_ref>sample string 2</_ref>
              <id>sample string 1</id>
              <label>sample string 3</label>
            </Choice>
          </choices>
          <id>sample string 1</id>
          <properties />
          <title>sample string 4</title>
          <type>sample string 3</type>
        </Field>
      </fields>
      <id>sample string 1</id>
      <title>sample string 2</title>
    </definition>
    <ending>
      <_ref>sample string 2</_ref>
      <id>sample string 1</id>
    </ending>
    <form_id>sample string 1</form_id>
    <landed_at>2024-10-17T11:20:16.8542941+01:00</landed_at>
    <submitted_at>2024-10-17T11:20:16.8542941+01:00</submitted_at>
    <token>sample string 2</token>
  </form_response>
</TypeFormObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Output

Name	Description	Type	Additional information
Response		boolean	None.
Error		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Error": "sample string 2"
}

application/xml, text/xml

Sample:

<Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TypeFormWebhook.Models">
  <Error>sample string 2</Error>
  <Response>true</Response>
</Output>