Definition

POST - webhooks/event/Respondent/Complete

Occurs when a respondent completes a survey.

Required roles: Results (read)

Response information


SurveyId

The respondent has completed this survey


Type integer
Respondent

The respondent who triggered the event


Type Respondent
WebhookId

The id of the webhook which triggered this request


Type integer
EventName

The EventName which triggered this request


Type string
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas
Sample:
{
  "SurveyId": 1,
  "Respondent": {
    "RespondentId": 1,
    "LanguageCode": "sample string 2",
    "RespondentStatusId": 3,
    "ResponseDate": "2019-06-19T10:05:43.2979027Z",
    "CompletionTime": 4,
    "DistributionMethodId": 5,
    "BrowserId": 64,
    "OsId": 64,
    "IsMobile": true,
    "IpAddress": "sample string 7",
    "RespondentReportUrl": "sample string 8",
    "ReportUrl": "sample string 9",
    "EditUrl": "sample string 10",
    "Responses": [
      {
        "QuestionId": 3,
        "DataLabel": "sample string 4",
        "ResponseId": 5,
        "Value": "sample string 6",
        "Tags": [
          {
            "TagId": 1,
            "SentimentScore": 1,
            "SalienceScore": 1.1
          },
          {
            "TagId": 1,
            "SentimentScore": 1,
            "SalienceScore": 1.1
          }
        ]
      },
      {
        "QuestionId": 3,
        "DataLabel": "sample string 4",
        "ResponseId": 5,
        "Value": "sample string 6",
        "Tags": [
          {
            "TagId": 1,
            "SentimentScore": 1,
            "SalienceScore": 1.1
          },
          {
            "TagId": 1,
            "SentimentScore": 1,
            "SalienceScore": 1.1
          }
        ]
      }
    ],
    "Location": {
      "Latitude": 2.0,
      "Longitude": 3.0,
      "CountryId": "sample string 4",
      "City": "sample string 5"
    },
    "Score": 11.1,
    "RespondentHash": "sample string 12",
    "PanelistStatusId": 14,
    "DateAdded": "2019-06-19T10:05:43.2979027Z",
    "DateInvited": "2019-06-19T10:05:43.2979027Z",
    "DateSawMail": "2019-06-19T10:05:43.2979027Z",
    "DateClickedThrough": "2019-06-19T10:05:43.2979027Z",
    "DateReminded": "2019-06-19T10:05:43.2979027Z",
    "DateRemindedPartial": "2019-06-19T10:05:43.2979027Z",
    "DateResponded": "2019-06-19T10:05:43.2979027Z",
    "Password": "sample string 15",
    "DateSentThankYouMail": "2019-06-19T10:05:43.2979027Z",
    "DateToBeInvited": "2019-06-19T10:05:43.2979027Z",
    "DateSecondReminder": "2019-06-19T10:05:43.2979027Z",
    "DateToExpire": "2019-06-19T10:05:43.2979027Z",
    "DateLastModified": "2019-06-19T10:05:43.2979027Z",
    "Surveys": [
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-06-19T10:05:43.2979027Z",
        "PanelistReportUrl": "sample string 5"
      },
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-06-19T10:05:43.2979027Z",
        "PanelistReportUrl": "sample string 5"
      }
    ],
    "Groups": [
      {
        "GroupId": 2,
        "Name": "sample string 3"
      },
      {
        "GroupId": 2,
        "Name": "sample string 3"
      }
    ],
    "LangCode": "en",
    "ContactId": 17,
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john.doe@mail.com",
    "CustomField1": "sample string 18",
    "CustomField2": "sample string 19",
    "CustomField3": "sample string 20",
    "CustomField4": "sample string 21",
    "CustomField5": "sample string 22",
    "CustomField6": "sample string 23",
    "CustomField7": "sample string 24",
    "CustomField8": "sample string 25",
    "CustomField9": "sample string 26",
    "CustomField10": "sample string 27",
    "CustomField11": "sample string 28",
    "CustomField12": "sample string 29",
    "CustomField13": "sample string 30",
    "CustomField14": "sample string 31",
    "CustomField15": "sample string 32",
    "CustomField16": "sample string 33",
    "CustomField17": "sample string 34",
    "CustomField18": "sample string 35",
    "CustomField19": "sample string 36",
    "CustomField20": "sample string 37",
    "Street": "Main Street",
    "HouseNumber": "123",
    "Suite": "B",
    "PostalCode": "98765-4321",
    "City": "Anytown",
    "State": "CA",
    "Province": "Orange County",
    "Phone": "+1-202-555-0117",
    "CountryId": "US",
    "Gender": "M",
    "DateOfBirth": "2019-06-19T10:05:43.2979027Z",
    "IsBounced": true,
    "IsOptedOut": true
  },
  "WebhookId": 3,
  "EventName": "sample string 4"
}
Sample:
<RespondentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <EventName>sample string 4</EventName>
  <WebhookId>3</WebhookId>
  <Respondent z:Id="i2">
    <Groups>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
    </Groups>
    <LangCode>en</LangCode>
    <Surveys>
      <SurveyReference z:Id="i3">
        <DateAdded>2019-06-19T10:05:43.2979027+00:00</DateAdded>
        <PanelistReportUrl>sample string 5</PanelistReportUrl>
        <PanelistStatusId>4</PanelistStatusId>
        <SurveyId>2</SurveyId>
        <Title>sample string 3</Title>
      </SurveyReference>
      <SurveyReference z:Ref="i3" />
    </Surveys>
    <ContactId>17</ContactId>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <Email>john.doe@mail.com</Email>
    <CustomField1>sample string 18</CustomField1>
    <CustomField2>sample string 19</CustomField2>
    <CustomField3>sample string 20</CustomField3>
    <CustomField4>sample string 21</CustomField4>
    <CustomField5>sample string 22</CustomField5>
    <CustomField6>sample string 23</CustomField6>
    <CustomField7>sample string 24</CustomField7>
    <CustomField8>sample string 25</CustomField8>
    <CustomField9>sample string 26</CustomField9>
    <CustomField10>sample string 27</CustomField10>
    <CustomField11>sample string 28</CustomField11>
    <CustomField12>sample string 29</CustomField12>
    <CustomField13>sample string 30</CustomField13>
    <CustomField14>sample string 31</CustomField14>
    <CustomField15>sample string 32</CustomField15>
    <CustomField16>sample string 33</CustomField16>
    <CustomField17>sample string 34</CustomField17>
    <CustomField18>sample string 35</CustomField18>
    <CustomField19>sample string 36</CustomField19>
    <CustomField20>sample string 37</CustomField20>
    <Street>Main Street</Street>
    <HouseNumber>123</HouseNumber>
    <Suite>B</Suite>
    <PostalCode>98765-4321</PostalCode>
    <City>Anytown</City>
    <State>CA</State>
    <Province>Orange County</Province>
    <Phone>+1-202-555-0117</Phone>
    <CountryId>US</CountryId>
    <Gender>M</Gender>
    <DateOfBirth>2019-06-19T10:05:43.2979027+00:00</DateOfBirth>
    <IsBounced>true</IsBounced>
    <IsOptedOut>true</IsOptedOut>
    <DateAdded>2019-06-19T10:05:43.2979027+00:00</DateAdded>
    <DateClickedThrough>2019-06-19T10:05:43.2979027+00:00</DateClickedThrough>
    <DateInvited>2019-06-19T10:05:43.2979027+00:00</DateInvited>
    <DateLastModified>2019-06-19T10:05:43.2979027+00:00</DateLastModified>
    <DateReminded>2019-06-19T10:05:43.2979027+00:00</DateReminded>
    <DateRemindedPartial>2019-06-19T10:05:43.2979027+00:00</DateRemindedPartial>
    <DateResponded>2019-06-19T10:05:43.2979027+00:00</DateResponded>
    <DateSawMail>2019-06-19T10:05:43.2979027+00:00</DateSawMail>
    <DateSecondReminder>2019-06-19T10:05:43.2979027+00:00</DateSecondReminder>
    <DateSentThankYouMail>2019-06-19T10:05:43.2979027+00:00</DateSentThankYouMail>
    <DateToBeInvited>2019-06-19T10:05:43.2979027+00:00</DateToBeInvited>
    <DateToExpire>2019-06-19T10:05:43.2979027+00:00</DateToExpire>
    <PanelistStatusId>14</PanelistStatusId>
    <Password>sample string 15</Password>
    <BrowserId>64</BrowserId>
    <CompletionTime>4</CompletionTime>
    <DistributionMethodId>5</DistributionMethodId>
    <EditUrl>sample string 10</EditUrl>
    <IpAddress>sample string 7</IpAddress>
    <IsMobile>true</IsMobile>
    <LanguageCode>sample string 2</LanguageCode>
    <Location>
      <City>sample string 5</City>
      <CountryId>sample string 4</CountryId>
      <Latitude>2</Latitude>
      <Longitude>3</Longitude>
    </Location>
    <OsId>64</OsId>
    <ReportUrl>sample string 9</ReportUrl>
    <RespondentHash>sample string 12</RespondentHash>
    <RespondentId>1</RespondentId>
    <RespondentReportUrl>sample string 8</RespondentReportUrl>
    <RespondentStatusId>3</RespondentStatusId>
    <ResponseDate>2019-06-19T10:05:43.2979027+00:00</ResponseDate>
    <Responses>
      <Response z:Id="i4">
        <DataLabel>sample string 4</DataLabel>
        <QuestionId>3</QuestionId>
        <ResponseId>5</ResponseId>
        <Tags>
          <ResponseStringTag>
            <SalienceScore>1.1</SalienceScore>
            <SentimentScore>1</SentimentScore>
            <TagId>1</TagId>
          </ResponseStringTag>
          <ResponseStringTag>
            <SalienceScore>1.1</SalienceScore>
            <SentimentScore>1</SentimentScore>
            <TagId>1</TagId>
          </ResponseStringTag>
        </Tags>
        <Value>sample string 6</Value>
      </Response>
      <Response z:Ref="i4" />
    </Responses>
    <Score>11.1</Score>
  </Respondent>
  <SurveyId>1</SurveyId>
</RespondentResult>