Occurs when a new survey is created.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Survey |
The survey for which the event is triggered. |
Survey | |
|
WebhookId
The id of the webhook which triggered this request
Type
integer
|
|||
| WebhookId |
The id of the webhook which triggered this request |
integer | |
|
EventName
The EventName which triggered this request
Type
string
|
|||
| 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 | |
{
"Survey": {
"Id": 1,
"Title": "sample string 2",
"SurveyStatusId": 3,
"CreateDate": "2024-12-21T18:05:13.7293814Z",
"LastModifyDate": "2024-12-21T18:05:13.7293814Z",
"StartDate": "2024-12-21T18:05:13.7293814Z",
"EndDate": "2024-12-21T18:05:13.7293814Z",
"IsTrial": true,
"PanelistCount": 1,
"RespondentCount": 1,
"CreatedBy": "sample string 4",
"QuestionCount": 1,
"Channels": {
"ViaEmail": {
"IsActive": true
},
"ViaWeb": {
"IsActive": true
},
"ViaPaper": {
"IsActive": true
},
"ViaTelephone": {
"IsActive": true
},
"ViaKiosk": {
"IsActive": true
},
"ViaSms": {
"IsActive": true
},
"ViaPanelProvider": {
"IsActive": true
}
},
"Options": {
"AllowEditingResponses": true,
"AllowMultipleSubmissions": true,
"MaximumRespondents": 1,
"MaximumCompletes": 1,
"AnonymousPanel": true,
"CooldownInDaysAfterInvitation": 1,
"CooldownInDaysAfterResponse": 1,
"ShowQuestionNumbering": true,
"ScoreMax": 7.0
},
"Questions": [
{
"$id": "1",
"Id": 1,
"DataLabel": "sample string 2",
"Language": "sample string 3",
"QuestionTypeId": 4,
"Caption": "sample string 5",
"Required": true,
"DataTypeId": 7,
"ScaleTypeId": 64,
"Hidden": true,
"MinValue": 1,
"MaxValue": 1,
"PageNumber": 8,
"OrderNumber": 9,
"QuestionNumber": 10,
"ParentQuestionId": 11,
"UseSentimentScore": true,
"SubQuestions": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"QuestionResponses": [
{
"ResponseId": 2,
"Caption": "sample string 3",
"Hidden": true,
"Other": true,
"NotApplicable": true,
"Order": 1,
"Value": 1.0,
"ScaleValue": 1
},
{
"ResponseId": 2,
"Caption": "sample string 3",
"Hidden": true,
"Other": true,
"NotApplicable": true,
"Order": 1,
"Value": 1.0,
"ScaleValue": 1
}
]
},
{
"$ref": "1"
}
],
"RespondentVisibility": {
"ShowContactId": true,
"ShowEmail": true,
"ShowLastname": true,
"ShowFirstname": true,
"ShowPanelistStatus": true,
"ShowLang": true,
"ShowDateOfBirth": true,
"ShowCustomField1": true,
"ShowCustomField2": true,
"ShowCustomField3": true,
"ShowCustomField4": true,
"ShowCustomField5": true,
"ShowCustomField6": true,
"ShowCustomField7": true,
"ShowCustomField8": true,
"ShowCustomField9": true,
"ShowCustomField10": true,
"ShowCustomField11": true,
"ShowCustomField12": true,
"ShowCustomField13": true,
"ShowCustomField14": true,
"ShowCustomField15": true,
"ShowCustomField16": true,
"ShowCustomField17": true,
"ShowCustomField18": true,
"ShowCustomField19": true,
"ShowCustomField20": true,
"ShowDateAdded": true,
"ShowDateMailed": true,
"ShowDateSawEmail": true,
"ShowDateClickedThrough": true,
"ShowDateReminded": true,
"ShowDateRemindedPartial": true,
"ShowDateResponded": true,
"ShowDateToExpire": true,
"ShowDateToBeInvited": true,
"ShowCompletionTime": true,
"ShowOs": true,
"ShowBrowser": true,
"ShowGender": true,
"ShowStreet": true,
"ShowHouseNumber": true,
"ShowSuite": true,
"ShowCity": true,
"ShowPostalCode": true,
"ShowProvince": true,
"ShowState": true,
"ShowCountryId": true,
"ShowPhone": true,
"CustomField1Name": "sample string 2",
"CustomField2Name": "sample string 3",
"CustomField3Name": "sample string 4",
"CustomField4Name": "sample string 5",
"CustomField5Name": "sample string 6",
"CustomField6Name": "sample string 7",
"CustomField7Name": "sample string 8",
"CustomField8Name": "sample string 9",
"CustomField9Name": "sample string 10",
"CustomField10Name": "sample string 11",
"CustomField11Name": "sample string 12",
"CustomField12Name": "sample string 13",
"CustomField13Name": "sample string 14",
"CustomField14Name": "sample string 15",
"CustomField15Name": "sample string 16",
"CustomField16Name": "sample string 17",
"CustomField17Name": "sample string 18",
"CustomField18Name": "sample string 19",
"CustomField19Name": "sample string 20",
"CustomField20Name": "sample string 21"
},
"DefaultLang": "sample string 7",
"ClientRef": "sample string 8",
"SurveyFolderId": 1
},
"WebhookId": 2,
"EventName": "sample string 3"
}
<SurveyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
<EventName>sample string 3</EventName>
<WebhookId>2</WebhookId>
<Survey z:Id="i2">
<ClientRef>sample string 8</ClientRef>
<DefaultLang>sample string 7</DefaultLang>
<SurveyFolderId>1</SurveyFolderId>
<Channels>
<ViaEmail>
<IsActive>true</IsActive>
</ViaEmail>
<ViaKiosk>
<IsActive>true</IsActive>
</ViaKiosk>
<ViaPanelProvider>
<IsActive>true</IsActive>
</ViaPanelProvider>
<ViaPaper>
<IsActive>true</IsActive>
</ViaPaper>
<ViaSms>
<IsActive>true</IsActive>
</ViaSms>
<ViaTelephone>
<IsActive>true</IsActive>
</ViaTelephone>
<ViaWeb>
<IsActive>true</IsActive>
</ViaWeb>
</Channels>
<CreateDate>2024-12-21T18:05:13.7293814+00:00</CreateDate>
<CreatedBy>sample string 4</CreatedBy>
<EndDate>2024-12-21T18:05:13.7293814+00:00</EndDate>
<Id>1</Id>
<IsTrial>true</IsTrial>
<LastModifyDate>2024-12-21T18:05:13.7293814+00:00</LastModifyDate>
<Options>
<AllowEditingResponses>true</AllowEditingResponses>
<AllowMultipleSubmissions>true</AllowMultipleSubmissions>
<AnonymousPanel>true</AnonymousPanel>
<CooldownInDaysAfterInvitation>1</CooldownInDaysAfterInvitation>
<CooldownInDaysAfterResponse>1</CooldownInDaysAfterResponse>
<MaximumCompletes>1</MaximumCompletes>
<MaximumRespondents>1</MaximumRespondents>
<ScoreMax>7</ScoreMax>
<ShowQuestionNumbering>true</ShowQuestionNumbering>
</Options>
<PanelistCount>1</PanelistCount>
<QuestionCount>1</QuestionCount>
<Questions>
<SurveyQuestion z:Id="i3">
<Caption>sample string 5</Caption>
<DataLabel>sample string 2</DataLabel>
<DataTypeId>7</DataTypeId>
<Hidden>true</Hidden>
<Id>1</Id>
<Language>sample string 3</Language>
<MaxValue>1</MaxValue>
<MinValue>1</MinValue>
<OrderNumber>9</OrderNumber>
<PageNumber>8</PageNumber>
<ParentQuestionId>11</ParentQuestionId>
<QuestionNumber>10</QuestionNumber>
<QuestionResponses>
<SurveyQuestionResponse z:Id="i4">
<Caption>sample string 3</Caption>
<Hidden>true</Hidden>
<NotApplicable>true</NotApplicable>
<Order>1</Order>
<Other>true</Other>
<ResponseId>2</ResponseId>
<ScaleValue>1</ScaleValue>
<Value>1</Value>
</SurveyQuestionResponse>
<SurveyQuestionResponse z:Ref="i4" />
</QuestionResponses>
<QuestionTypeId>4</QuestionTypeId>
<Required>true</Required>
<ScaleTypeId>64</ScaleTypeId>
<SubQuestions>
<SurveyQuestion z:Ref="i3" />
<SurveyQuestion z:Ref="i3" />
</SubQuestions>
<UseSentimentScore>true</UseSentimentScore>
</SurveyQuestion>
<SurveyQuestion z:Ref="i3" />
</Questions>
<RespondentCount>1</RespondentCount>
<RespondentVisibility>
<CustomField10Name>sample string 11</CustomField10Name>
<CustomField11Name>sample string 12</CustomField11Name>
<CustomField12Name>sample string 13</CustomField12Name>
<CustomField13Name>sample string 14</CustomField13Name>
<CustomField14Name>sample string 15</CustomField14Name>
<CustomField15Name>sample string 16</CustomField15Name>
<CustomField16Name>sample string 17</CustomField16Name>
<CustomField17Name>sample string 18</CustomField17Name>
<CustomField18Name>sample string 19</CustomField18Name>
<CustomField19Name>sample string 20</CustomField19Name>
<CustomField1Name>sample string 2</CustomField1Name>
<CustomField20Name>sample string 21</CustomField20Name>
<CustomField2Name>sample string 3</CustomField2Name>
<CustomField3Name>sample string 4</CustomField3Name>
<CustomField4Name>sample string 5</CustomField4Name>
<CustomField5Name>sample string 6</CustomField5Name>
<CustomField6Name>sample string 7</CustomField6Name>
<CustomField7Name>sample string 8</CustomField7Name>
<CustomField8Name>sample string 9</CustomField8Name>
<CustomField9Name>sample string 10</CustomField9Name>
<ShowBrowser>true</ShowBrowser>
<ShowCity>true</ShowCity>
<ShowCompletionTime>true</ShowCompletionTime>
<ShowContactId>true</ShowContactId>
<ShowCountryId>true</ShowCountryId>
<ShowCustomField1>true</ShowCustomField1>
<ShowCustomField10>true</ShowCustomField10>
<ShowCustomField11>true</ShowCustomField11>
<ShowCustomField12>true</ShowCustomField12>
<ShowCustomField13>true</ShowCustomField13>
<ShowCustomField14>true</ShowCustomField14>
<ShowCustomField15>true</ShowCustomField15>
<ShowCustomField16>true</ShowCustomField16>
<ShowCustomField17>true</ShowCustomField17>
<ShowCustomField18>true</ShowCustomField18>
<ShowCustomField19>true</ShowCustomField19>
<ShowCustomField2>true</ShowCustomField2>
<ShowCustomField20>true</ShowCustomField20>
<ShowCustomField3>true</ShowCustomField3>
<ShowCustomField4>true</ShowCustomField4>
<ShowCustomField5>true</ShowCustomField5>
<ShowCustomField6>true</ShowCustomField6>
<ShowCustomField7>true</ShowCustomField7>
<ShowCustomField8>true</ShowCustomField8>
<ShowCustomField9>true</ShowCustomField9>
<ShowDateAdded>true</ShowDateAdded>
<ShowDateClickedThrough>true</ShowDateClickedThrough>
<ShowDateMailed>true</ShowDateMailed>
<ShowDateOfBirth>true</ShowDateOfBirth>
<ShowDateReminded>true</ShowDateReminded>
<ShowDateRemindedPartial>true</ShowDateRemindedPartial>
<ShowDateResponded>true</ShowDateResponded>
<ShowDateSawEmail>true</ShowDateSawEmail>
<ShowDateToBeInvited>true</ShowDateToBeInvited>
<ShowDateToExpire>true</ShowDateToExpire>
<ShowEmail>true</ShowEmail>
<ShowFirstname>true</ShowFirstname>
<ShowGender>true</ShowGender>
<ShowHouseNumber>true</ShowHouseNumber>
<ShowLang>true</ShowLang>
<ShowLastname>true</ShowLastname>
<ShowOs>true</ShowOs>
<ShowPanelistStatus>true</ShowPanelistStatus>
<ShowPhone>true</ShowPhone>
<ShowPostalCode>true</ShowPostalCode>
<ShowProvince>true</ShowProvince>
<ShowState>true</ShowState>
<ShowStreet>true</ShowStreet>
<ShowSuite>true</ShowSuite>
</RespondentVisibility>
<StartDate>2024-12-21T18:05:13.7293814+00:00</StartDate>
<SurveyStatusId>3</SurveyStatusId>
<Title>sample string 2</Title>
</Survey>
</SurveyResult>