Definition

Respondent.Complete

Occurs when a respondent completes a survey.

Required roles: Results (read)

Request information


NameDescriptionTypeAdditional information
SurveyId

The respondent has completed this survey

integer

Respondent

The respondent who triggered the event

Respondent

WebhookId

The id of the webhook which triggered this request

integer

EventName

The EventName which triggered this request

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.

Hateoas

Sample:
{
  "SurveyId": 1,
  "Respondent": {
    "RespondentId": 1,
    "LanguageCode": "sample string 2",
    "RespondentStatusId": 3,
    "ResponseDate": "2019-04-20T00:15:15.142729Z",
    "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-04-20T00:15:15.142729Z",
    "DateInvited": "2019-04-20T00:15:15.142729Z",
    "DateSawMail": "2019-04-20T00:15:15.142729Z",
    "DateClickedThrough": "2019-04-20T00:15:15.142729Z",
    "DateReminded": "2019-04-20T00:15:15.142729Z",
    "DateRemindedPartial": "2019-04-20T00:15:15.142729Z",
    "DateResponded": "2019-04-20T00:15:15.142729Z",
    "Password": "sample string 15",
    "DateSentThankYouMail": "2019-04-20T00:15:15.142729Z",
    "DateToBeInvited": "2019-04-20T00:15:15.142729Z",
    "DateSecondReminder": "2019-04-20T00:15:15.142729Z",
    "DateToExpire": "2019-04-20T00:15:15.142729Z",
    "DateLastModified": "2019-04-20T00:15:15.142729Z",
    "Surveys": [
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-04-20T00:15:15.142729Z",
        "PanelistReportUrl": "sample string 5"
      },
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-04-20T00:15:15.142729Z",
        "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-04-20T00:15:15.142729Z",
    "IsBounced": true,
    "IsOptedOut": true
  },
  "WebhookId": 3,
  "EventName": "sample string 4"
}